What is Nextcloud?

How to use this image

This image is designed to be used in a micro-service environment. There are two versions of the
image you can choose from.
The apache tag contains a full Nextcloud installation including an apache web server. It is
designed to be easy to use and get's you running pretty fast. This is also the default for the latest
tag and version tags that are not further specified.
The second option is a fpm container. It is based on the php-fpm image and runs a fastCGI-Process
that serves your Nextcloud page. To use this image it must be combined with any webserver that
can proxy the http requests to the FastCGI-port of the container.

Using the apache image

The apache image contains a webserver and exposes port 80. To start the container type:
$ docker run -d -p 8080:80 nextcloud

Now you can access Nextcloud at http://localhost:8080/ from your host system.

Using the fpm image

To use the fpm image you need an additional web server that can proxy http-request to the fpm-port
of the container. For fpm connection this container exposes port 9000. In most cases you might
want use another container or your host as proxy. If you use your host you can address your
Nextcloud container directly on port 9000. If you use another container, make sure that you add
them to the same docker network (via docker run --network <NAME> ... or a
docker-compose file). In both cases you don't want to map the fpm port to you host.
$ docker run -d nextcloud:fpm

As the fastCGI-Process is not capable of serving static files (style sheets, images, ...) the webserver
needs access to these files. This can be achieved with the volumes-from option. You can find
more information in the docker-compose section.
Using an external database
By default this container uses SQLite for data storage, but the Nextcloud setup wizard (appears on
first run) allows connecting to an existing MySQL/MariaDB or PostgreSQL database. You can also
link a database container, e. g. --link my-mysql:mysql, and then use mysql as the database
host on setup. More info is in the docker-compose section.

Persistent data
The Nextcloud installation and all data beyond what lives in the database (file uploads, etc) is stored
in the unnamed docker volume volume /var/www/html. The docker daemon will store that data
within the docker directory /var/lib/docker/volumes/.... That means your data is saved
even if the container crashes, is stopped or deleted.
To make your data persistent to upgrading and get access for backups is using named docker
volume or mount a host folder. To achieve this you need one volume for your database container
and Nextcloud.
Nextcloud:
/var/www/html/ folder where all nextcloud data lives
$ docker run -d nextcloud \
-v nextcloud:/var/www/html

Database:
/var/lib/mysql MySQL / MariaDB Data
/var/lib/postresql/data PostegreSQL Data
$ docker run -d mariadb \
-v db:/var/lib/mysql

If you want to get fine grained access to your individual files, you can mount additional volumes for
data, config, your theme and custom apps. The data, config are stored in respective subfolders
inside /var/www/html/. The apps are split into core apps (which are shipped with Nextcloud
and you don't need to take care of) and a custom_apps folder. If you use a custom theme it
would go into the themes subfolder.

Overview of the folders that can be mounted as volumes:

/var/www/html Main folder, needed for updating
/var/www/html/custom_apps installed / modified apps
/var/www/html/config local configuration
/var/www/html/data the actual data of your Nextcloud
/var/www/html/themes/<YOU_CUSTOM_THEME> theming/branding

If you want to use named volumes for all of these it would look like this
$ docker run -d nextcloud \
-v nextcloud:/var/www/html \
-v apps:/var/www/html/custom_apps \
-v config:/var/www/html/config \
-v data:/var/www/html/data \
-v theme:/var/www/html/themes/<YOUR_CUSTOM_THEME>

Using the Nextcloud command-line interface

To use the Nextcloud command-line interface (aka. occ command):
$ docker exec --user www-data CONTAINER_ID php occ

or for docker-compose:
$ docker-compose exec --user www-data app php occ

Auto configuration via environment variables

The nextcloud image supports auto configuration via environment variables. You can preconfigure
everything that is asked on the install page on first run. To enable auto configuration, set your
database connection via the following environment variables. ONLY use one database type!
SQLITE_DATABASE:
SQLITE_DATABASE Name of the database using sqlite

MYSQL/MariaDB:
MYSQL_DATABASE Name of the database using mysql / mariadb.
MYSQL_USER Username for the database using mysql / mariadb.
MYSQL_PASSWORD Password for the database user using mysql / mariadb.
MYSQL_HOST Hostname of the database server using mysql / mariadb.

PostgreSQL:
POSTGRES_DB Name of the database using postgres.
POSTGRES_USER Username for the database using postgres.
POSTGRES_PASSWORD Password for the database user using postgres.
POSTGRES_HOST Hostname of the database server using postgres.

If you set any values, they will not be asked in the install page on first run. With a complete
configuration by using all variables for your database type, you can additionally configure your
Nextcloud instance by setting admin user and password (only works if you set both):
NEXTCLOUD_ADMIN_USER Name of the Nextcloud admin user.
NEXTCLOUD_ADMIN_PASSWORD Password for the Nextcloud admin user.

If you want you can set the data directory and table prefix, otherwise default values will be used.
NEXTCLOUD_DATA_DIR (default: /var/www/html/data) Configures the data directory
where nextcloud stores all files from the users.
 NEXTCLOUD_TABLE_PREFIX (default: "") Optional prefix for the tables. Used to be oc_
in the past

Running this image with docker-compose

The easiest way to get a fully featured and functional setup is using a docker-compose file.
There are too many different possibilities to setup your system, so here are only some examples
what you have to look for.
At first make sure you have chosen the right base image (fpm or apache) and added the features you
wanted (see below). In every case you want to add a database container and docker volumes to get
easy access to your persistent data. When you want to have your server reachable from the internet
adding HTTPS-encryption is mandatory! See below for more information.

Base version - apache

This version will use the apache image and add a mariaDB container. The volumes are set to keep
your data persistent. This setup provides no ssl encryption and is intended to run behind a proxy.
Make sure to set the variables MYSQL_ROOT_PASSWORD and MYSQL_PASSWORD before you run
this setup.
version: '2'

volumes:
nextcloud:
db:

services:
db:
image: mariadb
restart: always
volumes:
- db:/var/lib/mysql
environment:
- MYSQL_ROOT_PASSWORD=
- MYSQL_PASSWORD=
- MYSQL_DATABASE=nextcloud
- MYSQL_USER=nextcloud

app:
image: nextcloud
ports:
- 8080:80
links:
- db
volumes:
- nextcloud:/var/www/html
restart: always

Then run docker-compose up -d, now you can access Nextcloud at http://localhost:8080/
from your host system.
Base version - FPM
When using the FPM image you need another container that acts as web server on port 80 and
proxies the requests to the Nextcloud container. In this example a simple nginx container is
combined with the Nextcloud-fpm image and a MariaDB database container. The data is stored in
docker volumes. The nginx container also need access to static files from your Nextcloud
installation. It gets access to all the volumes mounted to Nextcloud via the volumes_from
option.The configuration for nginx is stored in the configuration file nginx.conf, that is
mounted into the container. An example can be found in the examples section here.
As this setup does not include encryption it should to be run behind a proxy.
Make sure to set the variables MYSQL_ROOT_PASSWORD and MYSQL_PASSWORD before you run
this setup.
version: '2'

volumes:
nextcloud:
db:

services:
db:
image: mariadb
restart: always
volumes:
- db:/var/lib/mysql
environment:
- MYSQL_ROOT_PASSWORD=
- MYSQL_PASSWORD=
- MYSQL_DATABASE=nextcloud
- MYSQL_USER=nextcloud

app:
image: nextcloud:fpm
links:
- db
volumes:
- nextcloud:/var/www/html
restart: always

web:
image: nginx
ports:
- 8080:80
links:
- app
volumes:
- ./nginx.conf:/etc/nginx/nginx.conf:ro
volumes_from:
- app
restart: always

Then run docker-compose up -d, now you can access Nextcloud at http://localhost:8080/
from your host system.
Make your Nextcloud available from the
internet
Until here your Nextcloud is just available from you docker host. If you want you Nextcloud
available from the internet adding SSL encryption is mandatory.

HTTPS - SSL encryption

There are many different possibilities to introduce encryption depending on your setup.
We recommend using a reverse proxy in front of our Nextcloud installation. Your Nextcloud will
only be reachable through the proxy, which encrypts all traffic to the clients. You can mount your
manually generated certificates to the proxy or use a fully automated solution, which generates and
renews the certificates for you.
In our examples section we have an example for a fully automated setup using a reverse proxy, a
container for Let's Encrypt certificate handling, database and Nextcloud. It uses the popular nginx-
proxy and docker-letsencrypt-nginx-proxy-companion containers. Please check the according
documentations before using this setup.

First use
When you first access your Nextcloud, the setup wizard will appear and ask you to choose an
administrator account, password and the database connection. For the database use db as host and
nextcloud as table and user name. Also enter the password you chose in your docker-
compose.yml file.

Update to a newer version

Updating the Nextcloud container is done by pulling the new image, throwing away the old
container and starting the new one. Since all data is stored in volumes, nothing gets lost. The startup
script will check for the version in your volume and the installed docker version. If it finds a
mismatch, it automatically starts the upgrade process. Don't forget to add all the volumes to your
new container, so it works as expected.
$ docker pull nextcloud
$ docker stop <your_nextcloud_container>
$ docker rm <your_nextcloud_container>
$ docker run <OPTIONS> -d nextcloud

Beware that you have to run the same command with the options that you used to initially start your
Nextcloud. That includes volumes, port mapping.
When using docker-compose your compose file takes care of your configuration, so you just have to
run:
$ docker-compose pull
$ docker-compose up -d

Adding Features
A lot of people want to use additional functionality inside their Nextcloud installation. If the image
does not include the packages you need, you can easily build your own image on top of it. Start
your derived image with the FROM statement and add whatever you like.
FROM nextcloud:apache

RUN ...

The examples folder gives a few examples on how to add certain functionalities, like including the
cron job, smb-support or imap-authentication.
If you use your own Dockerfile you need to configure your docker-compose file accordingly.
Switch out the image option with build. You have to specify the path to your Dockerfile. (in the
example it's in the same directory next to the docker-compose file)
app:
build: .
links:
- db
volumes:
- data:/var/www/html/data
- config:/var/www/html/config
- apps:/var/www/html/apps
restart: always

Updating your own derived image is also very simple. When a new version of the Nextcloud image
is available run:
docker build -t your-name --pull .
docker run -d your-name

or for docker-compose:
docker-compose build --pull
docker-compose up -d

The --pull option tells docker to look for new versions of the base image. Then the build
instructions inside your Dockerfile are run on top of the new image.

Migrating an existing installation

You're already using Nextcloud and want to switch to docker? Great! Here are some things to look
out for:
1. Define your whole Nextcloud infrastructure in a docker-compose file and run it with
docker-compose up -d to get the base installation, volumes and database. Work from
there.
 2. Restore your database from a mysqldump (nextcloud_db_1 is the name of your db
container)
docker cp ./database.dmp nextcloud_db_1:/dmp
docker-compose exec db sh -c "mysql -u USER -pPASSWORD nextcloud < /dmp"
docker-compose exec db rm /dmp

3. Edit your config.php

4. Set database connection
'dbhost' => 'db:3306',

2. Make sure you have no configuration for the apps_paths. Delete lines like these
- "apps_paths" => array (
- 0 => array (
- "path" => OC::$SERVERROOT."/apps",
- "url" => "/apps",
- "writable" => true,
- ),

3. Make sure your data directory is set to /var/www/html/data

'datadirectory' => '/var/www/html/data',

4. Copy your data (nextcloud_app_1 is the name of your Nextcloud container):

docker cp ./data/ nextcloud_app_1:/var/www/html/data
docker-compose exec app chown www-data:www-data /var/www/html/data
docker cp ./theming/ nextcloud_app_1:/var/www/html/theming
docker-compose exec app chown www-data:www-data /var/www/html/theming
docker cp ./config/config.php nextcloud_app_1:/var/www/html/config
docker-compose exec app chown www-data:www-data /var/www/html/config

5. Copy only the custom apps you use (or simply redownload them from the web interface):
docker cp ./apps/ nextcloud_data:/var/www/html/custom_apps
docker-compose exec app chown www-data:www-data /var/www/html/custom_apps