Storj NextCloud App

Adds external storage support for Storj Decentralized Cloud Storage to Nextcloud

Storj Community contributed.

• Docker image
• Prerequisites
  • Detailed instructions for docker version of Nextcloud
• Installation
• Configuration
• Maintainers
  • Building
  • Publish to App Store
  • Running tests
• Known issues

Docker image

We supply a ready-to-use Docker image with Nextcloud and Storj pre-installed.

docker run --name nextcloud \
    --env OBJECTSTORE_STORJ_ACCESS_GRANT=myaccessgrant \
    --env OBJECTSTORE_STORJ_BUCKET=mybucket \
    storjthirdparty/nextcloud-app:25.0.0-apache

More information at hub.docker.com

Prerequisites

• Linux
• x86_64 or ARM64
• libffi installed

The PHP installation should have the FFI extension loaded and enabled unconditionally in php.ini:

extension=ffi

ffi.enable=true

Detailed instructions depend on your distro.

Detailed instructions for docker version of Nextcloud

By default the Nextcloud docker image comes without FFI support. But you can install it inside the container:

docker exec -it nextcloud bash
root@5f11b342df44:/var/www/html# apt update 
root@5f11b342df44:/var/www/html# apt install libffi-dev
root@5f11b342df44:/var/www/html# docker-php-ext-install ffi

("nextcloud" is the name you gave the container earlier)

The extension is now enabled through /usr/local/etc/php/conf.d/docker-php-ext-ffi.ini

Also allow loading libraries at runtime:

root@5f11b342df44:/var/www/html# echo ffi.enable=true > /usr/local/etc/php/conf.d/ffi.ini

Reload Apache:

root@5f11b342df44:/var/www/html# apachectl graceful

To make changes permanent you need to build your own image. Create a Dockerfile:

FROM nextcloud
RUN apt update && apt install -y libffi-dev && docker-php-ext-install ffi
RUN echo ffi.enable=true > /usr/local/etc/php/conf.d/ffi.ini

And build it:

docker build . -t my/nextcloud

Now you can run your own image, change docker run ... nextcloud to docker run ... my/nextcloud

Installation

This app is published on the App Store.

There are two ways to install:

• Install from the App Store GUI of your Nextcloud instance. Tap on your profile (top right) and then "+ Apps"
• Download and extract the tarball in the folder apps of your Nextcloud installation

Configuration

Storj works like any external object storage. See the documentation on docs.nextcloud.com:

• Configuring External Storage (GUI)
• Configuring Object Storage as Primary Storage

This is the configuration to set Storj as your primary storage:

$CONFIG = [
    'objectstore' => [
        'class' => \OCA\Storj\StorjObjectStore::class,
        'arguments' => [
            'serialized_access' => 'myaccessgrant',
            'bucket' => 'mynextcloudbucket',
        ]
    ]
];

Primary storage is more responsive because it relies more on your local database, but does create small files, which is not the best usecase for Storj.

Maintainers

Building

The app can be built by using the provided Makefile by running:

make

Publish to App Store

Bump the version in ./appinfo/info.xml

Build un:

make && make appstore

The archive is located in build/artifacts/appstore. Follow the instructions at https://apps.nextcloud.com/developer/apps/releases/new to upload the app to the store.

Running tests

You can use the provided Makefile to run all tests by using:

make test

This will run the PHP unit and integration tests and if a package.json is present in the js/ folder will execute npm run test

Of course you can also install PHPUnit and use the configurations directly:

phpunit -c phpunit.xml

or:

phpunit -c phpunit.integration.xml

for integration tests

Known issues

• Enabling Xdebug profiling or debugging will cause a segfault