Skip to content

DyonR/docker-nextcloudcmd-client

Repository files navigation

docker-nextcloudcmd-client

Docker Pulls Docker Image Size (tag)

A Dockerized Nextcloud command-line client (nextcloudcmd) to sync from any supported Nextcloud(-like) environment.
This container should work with:

  • Any standard Nextcloud server
  • TransIP STACK
  • Other compatible WebDAV-based Nextcloud-like storage platforms

⚠️ This project is only tested with TransIP's STACK.

This project is a continuation of docker-nextcloudcmd-client to use Nextcloud instead of ownCloud.

Use Case

This container is designed to continuously synchronize files from a remote Nextcloud(-like) storage to your local machine via Docker.
Example use case: You have a remote cloud account (e.g., your friend's Nextcloud or a TransIP STACK instance), and you want that data synced to your server via Docker.

Docker Features

  • Base: Debian 12
  • Image Size: <150MB
  • Folder-specific sync support
  • Built with Unraid compatibility in mind

Run container from Docker registry

The container is available from the Docker registry and this is the simplest way to get it.

To run the container use this command:

$ docker run -d \
             --name='nextcloudcmd-client' \
             -v /your/nextclouddata/path/:/nextclouddata \
             -e NEXTCLOUD_USER=nextcloud_username \
             -e NEXTCLOUD_PASS=nextcloud_password \
             -e NEXTCLOUD_SERVER=mynextcloud.com \
             --restart unless-stopped \
             'dyonr/nextcloudcmd-client'

Environment Variables & Volumes

Environment Variables

Variable Required Function Example Default
NEXTCLOUD_USER Yes Username (or email) to connect to Nextcloud NEXTCLOUD_USER=dyonr
NEXTCLOUD_PASS Yes Password or App-Token for the Nextcloud user NEXTCLOUD_PASS=ac98df79ed7fb
NEXTCLOUD_SERVER Yes Nextcloud Environment server address, with port if it's not a default port number NEXTCLOUD_SERVER=example.com:8443
NEXTCLOUD_PROTO No Connect via http or https NEXTCLOUD_PROTO=https https
NEXTCLOUD_URLPATH No Server path to the Nextcloud instance (example: https://example.com:8443/Nextcloud/ becomes /Nextcloud/) NEXTCLOUD_URLPATH=/Nextcloud/ /Nextcloud/
NEXTCLOUD_WEBDAV No In case the webdav path is not remote.php/webdav, you can change it here NEXTCLOUD_WEBDAV=remote.php/webdav remote.php/webdav
NEXTCLOUD_FILEPATH No Only sync one specific folder NEXTCLOUD_FILEPATH=/Pictures/Holiday-2020 /
TRUST_SELFSIGN No Ignore self-signed certificate errors (Set to 1 to ignore SSL errors) TRUST_SELFSIGN=0 0
SYNC_HIDDEN No Set to 1 to sync all hidden files within the specified Nextcloud directory SYNC_HIDDEN=0 0
SILENCE_OUTPUT No Set to 0 to get more verbose output SILENCE_OUTPUT=1 1
RUN_INTERVAL No Interval in seconds at which the client will run and check for changes RUN_INTERVAL=60 30
RUN_UID No UID of the occlient user and the /nextclouddata folder/files RUN_UID=99 99
RUN_GID No GID of the occlient user and the /nextclouddata folder/files RUN_GID=100 100

Volumes

Volume Required Function Example
nextclouddata Yes Nextcloud sync location /your/nextclouddata/path/:/nextclouddata

Ports

This Docker container exposes no ports, has no UI and therefore does not need to have any ports exposed.

Issues

If you're experiencing problems:

  1. Check the logs at /opt/Nextcloud/log/latest.log
  2. Open a GitHub issue
  3. Include:
    • Docker version
    • OS and kernel version
    • Relevant logs
    • Environment variables used (obfuscate sensitive info)

❗Please use the latest versions of Docker and this container whenever possible. Support is provided on a best-effort basis.

Disclaimer

I am not responsible for any data loss due wrong configurations.

About

Dockerized Nextcloud command line client (nextcloudcmd) to sync from any supported Nextcloud(-like) environment.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors