docker-documentation/images/docker-nextcloud.md

13 KiB

title
nextcloud

linuxserver/nextcloud

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry MicroBadger Layers Docker Pulls Docker Stars Jenkins Build LSIO CI

Nextcloud gives you access to all your files wherever you are.

Where are your photos and documents? With Nextcloud you pick a server of your choice, at home, in a data center or at a provider. And that is where your files will be. Nextcloud runs on that server, protecting your data and giving you access from your desktop or mobile devices. Through Nextcloud you also access, sync and share your existing data on that FTP drive at the office, a Dropbox or a NAS you have at home.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling ghcr.io/linuxserver/nextcloud should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Tag
x86-64 amd64-latest
arm64 arm64v8-latest
armhf arm32v7-latest

Version Tags

This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.

Tag Description
latest Stable Nextcloud releases (currently php7)
php8 Experimental php8 based Nextcloud releases

Application Setup

Access the webui at https://<your-ip>:443, for more information check out Nextcloud.

Docker image update and recreation of container alone won't update nextcloud version.

In order to update nextcloud version, you have two options, firstly make sure you are using the latest docker image,then either

  1. Perform the in app gui update.
  2. Use the CLI version by running docker exec -it nextcloud updater.phar (Both of these are described here)

Note: Both occ and updater.phar can be run without prepending with sudo -u abc php or sudo -u www-data php

If you are not customizing our default nginx configuration you will need to remove the file:

/config/nginx/site-confs/default

Then restart the container to replace it with the latest one.

Collaborative Editing

Nextcloud's built-in collaborative editing packages (Collabora/CODE and OnlyOffice) only work on x86_64 systems with glibc, and therefore they are not compatible with our images. You should create separate containers for them and set them up in Nextcloud with their respective connector addons.

If (auto) installed, those built-in packages may cause instability and should be removed.

Usage

Here are some example snippets to help you get started creating a container from this image.

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  nextcloud:
    image: ghcr.io/linuxserver/nextcloud
    container_name: nextcloud
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - /path/to/appdata:/config
      - /path/to/data:/data
    ports:
      - 443:443
    restart: unless-stopped

docker cli

docker run -d \
  --name=nextcloud \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 443:443 \
  -v /path/to/appdata:/config \
  -v /path/to/data:/data \
  --restart unless-stopped \
  ghcr.io/linuxserver/nextcloud

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
443 WebUI

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Europe/London Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume Function
/config Nextcloud configs.
/data Your personal data.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running:
    • docker exec -it nextcloud /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f nextcloud
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' nextcloud
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/nextcloud

Versions

  • 21.03.21: - Publish php8 tag for testing.
  • 25.02.21: - Nginx default site config updated for v21 (existing users should delete /config/nginx/site-confs/default and restart the container).
  • 21.01.21: - Fix php iconv (was breaking the mail addon). If installed, attempt to remove broken CODE Server app during startup.
  • 20.01.21: - Increase php fcgi timeout to prevent 504 Gateway timeout errors (existing users should delete /config/nginx/site-confs/default and restart the container).
  • 16.01.21: - Rebasing to alpine 3.13. Users with issues on 32-bit arm, see this article.
  • 12.08.20: - Various updates to default site config, including added support for webfinger (existing users should delete /config/nginx/site-confs/default and restart the container).
  • 03.06.20: - Rebasing to alpine 3.12
  • 03.06.20: - Add php7-bcmath and php7-fileinfo
  • 31.05.20: - Add aliases for occ and updater.phar
  • 31.03.20: - Allow crontab to be user customized, fix logrotate.
  • 17.01.20: - Updated php.ini defaults and site config, including an optional HSTS directive (existing users should delete /config/nginx/site-confs/default and restart the container).
  • 19.12.19: - Rebasing to alpine 3.11.
  • 18.11.19: - Nginx default site config updated for v17 (existing users should delete /config/nginx/site-confs/default and restart the container).
  • 28.10.19: - Change cronjob to run every 5 minutes.
  • 24.10.19: - Nginx default site config updated due to CVE-2019-11043 (existing users should delete /config/nginx/site-confs/default and restart the container).
  • 14.07.19: - Download nextcloud during build time.
  • 28.06.19: - Rebasing to alpine 3.10.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 27.02.19: - Updating base nginx config to sync up with v15 requirements.
  • 22.02.19: - Rebasing to alpine 3.9.
  • 28.01.19: - Add pipeline logic and multi arch.
  • 25.01.19: - Add php7-phar for occ upgrades.
  • 05.09.18: - Rebase to alpine 3.8.
  • 11.06.18: - Use latest rather than specific version for initial install.
  • 26.04.18: - Bump default install to 13.0.1.
  • 06.02.18: - Bump default install to 13.0.0.
  • 26.01.18: - Rebase to alpine 3.7, bump default install to 12.0.5.
  • 12.12.17: - Bump default install to 12.0.4, fix continuation lines.
  • 15.10.17: - Sed php.ini for opcache requirements in newer nextcloud versions.
  • 20.09.17: - Bump default install to 12.0.3.
  • 19.08.17: - Bump default install to 12.0.2.
  • 25.05.17: - Rebase to alpine 3.6.
  • 22.05.17: - Update to nextcloud 12.0, adding required dependecies and note about commenting out SAMEORIGIN; line.
  • 03.05.17: - Use community repo of memcache.
  • 07.03.17: - Release into main repository and upgrade to php7 and Alpine 3.5.