Skip to content

Latest commit

 

History

History
413 lines (304 loc) · 22.3 KB

README.md

File metadata and controls

413 lines (304 loc) · 22.3 KB

linuxserver.io

Blog Discord Discourse Fleet GitHub Open Collective

The LinuxServer.io team brings you another container release featuring:

  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:

  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • Fleet - an online web interface which displays all of our maintained images.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io 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.

nextcloud

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/nextcloud:latest 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 Available Tag
x86-64 amd64-<version tag>
arm64 arm64v8-<version tag>
armhf

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag Available Description
latest Stable Nextcloud releases
develop Beta Nextcloud pre-releases only
previous Nextcloud releases from the previous major version

Application Setup

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

Note: occ should be run without prepending with sudo -u abc php or sudo -u www-data php ie; docker exec -it nextcloud occ maintenance:mode --off

Updating Nextcloud

Updating Nextcloud is done by pulling the new image, and recreating the container with it.

It is only possible to upgrade one major version at a time. For example, if you want to upgrade from version 14 to 16, you will have to upgrade from version 14 to 15, then from 15 to 16.

Since all data is stored in the /config and /data 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.

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.

HEIC Image Previews

In order to enable HEIC image preview generation you will need to add the following to your config.php file in your `config/www/nextcloud/config' directory;

  'enable_previews' => true,
  'enabledPreviewProviders' =>
  array (
    'OC\Preview\PNG',
    'OC\Preview\JPEG',
    'OC\Preview\GIF',
    'OC\Preview\BMP',
    'OC\Preview\XBitmap',
    'OC\Preview\MP3',
    'OC\Preview\TXT',
    'OC\Preview\MarkDown',
    'OC\Preview\OpenDocument',
    'OC\Preview\Krita',
    'OC\Preview\HEIC',
  ),

You may need to log out and back in for the changes to come in to effect.

This fix was sourced from Nextcloud Documentation

Nextcloud state that HEIC preview is disabled by default due to performance or privacy concerns, so enable this at your own risk.

Custom App Directories

If you are using custom app directories you will need to make the custom folder(s) you are using available to the web server. The recommended way to do this with our container is to add a volume. Ex:

    volumes:
      - /path/to/your_custom_apps_folder:/app/www/public/your_custom_apps_folder

Afterwards, you can set "path" => OC::$SERVERROOT . "/your_custom_apps_folder", in your config.php file, per the official documentation.

Strict reverse proxies

This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

Note

Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  nextcloud:
    image: lscr.io/linuxserver/nextcloud:latest
    container_name: nextcloud
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/nextcloud/config:/config
      - /path/to/data:/data
    ports:
      - 443:443
    restart: unless-stopped
docker run -d \
  --name=nextcloud \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 443:443 \
  -v /path/to/nextcloud/config:/config \
  -v /path/to/data:/data \
  --restart unless-stopped \
  lscr.io/linuxserver/nextcloud:latest

Parameters

Containers 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.

Parameter Function
-p 443:443 WebUI
-e PUID=1000 for UserID - see below for explanation
-e PGID=1000 for GroupID - see below for explanation
-e TZ=Etc/UTC specify a timezone to use, see this list.
-v /config Persistent config files
-v /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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

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" }}' lscr.io/linuxserver/nextcloud:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

  • Update images:

    • All images:

      docker-compose pull
    • Single image:

      docker-compose pull nextcloud
  • Update containers:

    • All containers:

      docker-compose up -d
    • Single container:

      docker-compose up -d nextcloud
  • You can also remove the old dangling images:

    docker image prune

Via Docker Run

  • Update the image:

    docker pull lscr.io/linuxserver/nextcloud:latest
  • Stop the running container:

    docker stop nextcloud
  • Delete the container:

    docker rm nextcloud
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

  • You can also remove the old dangling images:

    docker image prune

Image Update Notifications - Diun (Docker Image Update Notifier)

Tip

We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-nextcloud.git
cd docker-nextcloud
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/nextcloud:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 09.07.24: - Add previous tag for n-1 releases.
  • 24.06.24: - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
  • 19.05.24: - Added util-linux package required for taskset.
  • 10.04.24: - Added imagemagick-pdf.
  • 05.04.24: - Added imagemagick-heic. Manual update to config.php required - see above.
  • 02.04.24: - Existing users should update: site-confs/default.conf - Add support for the Client Push (notify_push) plugin and the new mod.
  • 22.03.24: - Add imagemagick-svg module.
  • 06.03.24: - Rebase to Alpine 3.19 with php 8.3.
  • 02.01.24: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
  • 22.12.23: - Site default conf updating to include mime.types for js and mjs and update location to include more file types.
  • 28.10.23: - Disable web upgrades using occ during init.
  • 31.08.23: - Re-add updatenotification app. This allows users to be notified for app updates, but also notifies for NextCloud updates. Updating NextCloud via the web UI is not supported when using this image.
  • 14.08.23: - Add develop branch.
  • 25.06.23: - Move Nextcloud installation inside container. Remove CLI updater. See changes announcement.
  • 21.06.23: - Existing users should update /config/nginx/site-confs/default.conf - Security fix for real ip settings.
  • 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
  • 13.04.23: - Move ssl.conf include to default.conf.
  • 21.03.23: - Add php81-sysvsem as new dep for v26. Update default X-Robots-Tag to `noindex, nofollow``.
  • 02.03.23: - Set permissions on crontabs during init.
  • 20.01.23: - Rebase to alpine 3.17 with php8.1.
  • 10.10.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
  • 30.09.22: - Disabled output_buffering as per [nextcloud docs](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/big_file_upload_configuration.html
  • 21.05.22: - Update version check endpoint.
  • 28.04.22: - Increase OPCache interned strings buffered setting to 16.
  • 14.04.22: - Nginx default site config updated for v23 (existing users should delete /config/nginx/site-confs/default.conf and restart the container). Fix LDAP connection.
  • 11.09.21: - Rebasing to alpine 3.14
  • 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.conf 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.conf 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.conf 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.conf 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.conf 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.conf 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.