Rework Readme file (#53)
* Rework Readme file * Fixed db-folder paths * Typos * Fixed Typos * Fix typo * Use pull to correctly pull a newer base image * Moved heading to the top * Clarify serving of static files in the fpm container * Update Persistant data * Added theming. * Added information on apps and custom_apps folder. * Typos, clarification * Added migration part * Fix wrong use of --pull * Reordering, spelling, clarification * Specified volumes section * Corrected examples * Added /var/www/html to the fine grained volume approach Also added a line on upgrading. * Typos in migration section * Updated SSL-encryption, Typos, removed "..." * Typos and some layout improvements * Typo, typo, typo :D * Added hint to set passwords * added links for external containers in ssl example
This commit is contained in:
Marc Brückner
Tilo Spannagel
parent
20694c47e7
commit
f8a4572935
300
README.md
300
README.md
|
|
@ -1,53 +1,311 @@
|
|||
# What is Nextcloud?
|
||||
|
||||
[](https://doi-janky.infosiftr.net/job/update.sh/job/nextcloud)
|
||||
[](https://travis-ci.org/nextcloud/docker)
|
||||
|
||||
What is Nextcloud?
|
||||
|
||||
A safe home for all your data. Access & share your files, calendars, contacts, mail & more from any device, on your terms.
|
||||
|
||||
|
||||
|
||||
# How to use this image
|
||||
This image is designed to be used in a micro-service environment. It consists of the Nextcloud installation in an [php-fpm](https://hub.docker.com/_/php/) container. To use this image it must be combined with any webserver that can proxy the http requests to the FastCGI-port of the container.
|
||||
This image is designed to be used in a micro-service environment. There are two versions of the image you can choose from.
|
||||
|
||||
## Start Nextcloud
|
||||
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.
|
||||
|
||||
Starting Nextcloud php-fpm instance listening on port 9000 is as easy as the following:
|
||||
The second option is a `fpm` container. It is based on the [php-fpm](https://hub.docker.com/_/php/) 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:
|
||||
|
||||
```console
|
||||
$ docker run -d nextcloud
|
||||
```
|
||||
|
||||
Now you can get access to fpm running on port 9000 inside the container. If you want to access it from the internet, we recommend using a reverse proxy in front. You can install it directly on your machine or use an additional container (You can find more information on that on the docker-compose section). Once you have a reverse proxy, you can access Nextcloud at http://localhost/ and go through the wizard.
|
||||
Now you can access Nextcloud at http://localhost/ 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.
|
||||
|
||||
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.
|
||||
```console
|
||||
$ 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](https://docs.docker.com/engine/tutorials/dockervolumes/#adding-a-data-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.
|
||||
|
||||
All data beyond that which lives in the database (file uploads, etc) is stored within the default volume `/var/www/html`. With this volume, Nextcloud will only be updated when the file `version.php` is not present.
|
||||
To make your data persistant 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.
|
||||
|
||||
- `-v /<mydatalocation>:/var/www/html`
|
||||
Nextcloud:
|
||||
- `/var/www/html/` folder where all nextcloud data lives
|
||||
```console
|
||||
$ docker run -d nextcloud \
|
||||
-v nextcloud:/var/www/html
|
||||
```
|
||||
|
||||
For fine grained data persistence, you can use 3 volumes, as shown below.
|
||||
Database:
|
||||
- `/var/lib/mysql` MySQL / MariaDB Data
|
||||
- `/var/lib/postresql/data` PostegreSQL Data
|
||||
```console
|
||||
$ docker run -d mariadb \
|
||||
-v db:/var/lib/mysql
|
||||
```
|
||||
|
||||
- `-v /<mydatalocation>/apps:/var/www/html/apps` installed / modified apps
|
||||
- `-v /<mydatalocation>/config:/var/www/html/config` local configuration
|
||||
- `-v /<mydatalocation>/data:/var/www/html/data` the actual data of your Nextcloud
|
||||
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` (wich 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.
|
||||
|
||||
## ... via [`docker-compose`](https://github.com/docker/compose)
|
||||
Overview of the folders that can be mounted as volumes:
|
||||
|
||||
The recommended minimal setup is using this image in combination with two containers: A database container and a reverse proxy for the http connection to the service.
|
||||
A working example can be found at [IndieHosters/Nextcloud](https://github.com/indiehosters/nextcloud).
|
||||
- `/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/theme/<YOU_CUSTOM_THEME>` theming/branding
|
||||
|
||||
If you want to access your Nextcloud from the internet we recommend configuring your reverse proxy to use encryption (for example via [let's Encrypt](https://letsencrypt.org/))
|
||||
If you want to use named volumes for all of these it would look like this
|
||||
```console
|
||||
$ 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>
|
||||
```
|
||||
|
||||
## Update to a newer version
|
||||
|
||||
To update your Nextcloud version you simply have to pull and start the new container.
|
||||
# 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_PW` and `MYSQL_USER_PW` before you run this setup.
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
|
||||
volumes:
|
||||
nextcloud:
|
||||
db:
|
||||
|
||||
services:
|
||||
db:
|
||||
image: mariadb
|
||||
restart: always
|
||||
volumes:
|
||||
- db:/var/lib/mysql
|
||||
environment:
|
||||
- MYSQL_ROOT_PW=
|
||||
- MYSQL_USER_PW=
|
||||
- MYSQL_DATABASE=nextcloud
|
||||
- MYSQL_USER=nextcloud
|
||||
|
||||
app:
|
||||
image: nextcloud
|
||||
links:
|
||||
- db
|
||||
volumes:
|
||||
- nextcloud:/var/www/html
|
||||
restart: always
|
||||
|
||||
```
|
||||
|
||||
## 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 combindes 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](https://github.com/nextcloud/docker/tree/master/.examples).
|
||||
|
||||
As this setup does **not include ecryption** it should to be run behind a proxy.
|
||||
|
||||
Make sure to set the variables `MYSQL_ROOT_PW` and `MYSQL_USER_PW` before you run this setup.
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
|
||||
volumes:
|
||||
nextcloud:
|
||||
db:
|
||||
|
||||
services:
|
||||
db:
|
||||
image: mariadb
|
||||
restart: always
|
||||
volumes:
|
||||
- db:/var/lib/mysql
|
||||
environment:
|
||||
- MYSQL_ROOT_PW=
|
||||
- MYSQL_USER_PW=
|
||||
- MYSQL_DATABASE=nextcloud
|
||||
- MYSQL_USER=nextcloud
|
||||
|
||||
app:
|
||||
image: nextcloud
|
||||
links:
|
||||
- db
|
||||
volumes:
|
||||
- nextcloud:/var/www/html
|
||||
restart: always
|
||||
|
||||
web:
|
||||
image: nginx
|
||||
links:
|
||||
- app
|
||||
volumes:
|
||||
- ./nginx.conf:/etc/nginx/nginx.conf:ro
|
||||
volumes-from:
|
||||
- app
|
||||
restart: always
|
||||
```
|
||||
# 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](https://github.com/nextcloud/docker/tree/master/.examples) section we have an example for a fully automated setup using a reverse proxy, a container for [Let's Encrypt](https://letsencrypt.org/) certificate handling, database and Nextcloud. It uses the popular [nginx-proxy](https://github.com/jwilder/nginx-proxy) and [docker-letsencrypt-nginx-proxy-companion](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion) containers. Please check the according documentations before using this setup.
|
||||
|
||||
## HTTP - insecure, just for development / debugging / testing
|
||||
When you're testing you can use this image without the ssl encryption. **Never use this method on a Nextcloud install where actual user data is stored!**
|
||||
|
||||
You just have to map the webserver port to your host. For the apache image add `-p 80:80` to your docker run command or add to your compose file:
|
||||
```diff
|
||||
...
|
||||
app:
|
||||
image: nextcloud
|
||||
+ ports:
|
||||
+ - 80:80
|
||||
...
|
||||
```
|
||||
|
||||
For the fpm image you need a webserver in front. If you're following the docker-compose example above, add:
|
||||
```diff
|
||||
...
|
||||
web:
|
||||
image: nginx
|
||||
+ ports:
|
||||
+ - 80:80
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
# 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.
|
||||
|
||||
```console
|
||||
$ docker pull nextcloud
|
||||
$ docker run -d nextcloud
|
||||
$ docker stop <your_nextcloud_container>
|
||||
$ docker rm <your_nextcloud_container>
|
||||
$ docker run <OPTIONS> -d nextcloud
|
||||
```
|
||||
When you access your site the update wizard will show up.
|
||||
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:
|
||||
|
||||
```console
|
||||
$ 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.
|
||||
|
||||
```yaml
|
||||
FROM nextcloud:apache
|
||||
|
||||
RUN ...
|
||||
|
||||
```
|
||||
The [examples folder](https://github.com/nextcloud/docker/blob/master/.examples) 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)
|
||||
|
||||
```yaml
|
||||
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:
|
||||
|
||||
```console
|
||||
docker build -t your-name --pull .
|
||||
docker run -d your-name
|
||||
```
|
||||
|
||||
or for docker-compose:
|
||||
```console
|
||||
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)
|
||||
```console
|
||||
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
|
||||
1. Set database connection
|
||||
```php
|
||||
'dbhost' => 'db:3306',
|
||||
```
|
||||
2. Make sure you have no configuration for the `apps_paths`. Delete lines like these
|
||||
```diff
|
||||
- "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
|
||||
```php
|
||||
'datadirectory' => '/var/www/html/data',
|
||||
```
|
||||
|
||||
|
||||
4. Copy your data (nextcloud_app_1 is the name of your Nextcloud container):
|
||||
```console
|
||||
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):
|
||||
```console
|
||||
docker cp ./apps/ nextcloud_data:/var/www/html/custom_apps
|
||||
docker-compose exec app chown www-data:www-data /var/www/html/custom_apps
|
||||
```
|
||||
|
||||
# Questions / Issues
|
||||
If you got any questions or problems using the image, please visit our [Github Repository](https://github.com/nextcloud/docker) and write an issue.
|
||||
|
|
|
|||
Loading…
Reference in New Issue