https://github.com/perry-mitchell/nextcloud-directory-sync
Docker app for syncing a single directory from a Nextcloud server
https://github.com/perry-mitchell/nextcloud-directory-sync
Last synced: about 1 year ago
JSON representation
Docker app for syncing a single directory from a Nextcloud server
- Host: GitHub
- URL: https://github.com/perry-mitchell/nextcloud-directory-sync
- Owner: perry-mitchell
- License: mit
- Created: 2022-11-10T15:10:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-10T18:41:28.000Z (over 3 years ago)
- Last Synced: 2025-02-22T18:24:25.517Z (over 1 year ago)
- Language: Shell
- Size: 5.86 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nextcloud Directory Sync
> Docker app for syncing a single directory from a Nextcloud server
This docker application provides a simple interface that allows you to perpetually synchronise a directory from a Nextcloud server to a local directory, mounted using a volume.
## Obtaining the image
Pull the latest image to get started: `perrymitchell/nextcloud-directory-sync:latest`. Check it out on [DockerHub](https://hub.docker.com/r/perrymitchell/nextcloud-directory-sync).
## Configuring
For the app to run successfully, a number of environment variables are required:
| Variable | Default | Required | Description |
|-------------------|---------------|-----------|---------------------------------------------------|
| `NC_HOST` | _None_ | Yes | The host URL of the target Nextcloud instance. |
| `NC_USERNAME` | _None_ | Yes | Nextcloud username. |
| `NC_PASSWORD` | _None_ | Yes | Nextcloud password. |
| `PATH_LOCAL` | `/nextcloud` | No | The local directory inside the Docker container to sync to. |
| `PATH_REMOTE` | `/` | No | The remote Nextcloud directory to sync with. |
| `PGID` | `1000` | No | Optional group ID for the `nextcloud` user to use for syncing. |
| `PUID` | `1000` | No | Optional user ID for the `nextcloud` user to use for syncing. |
| `SYNC_WAIT` | `60` | No | Delay, in seconds, between sync attempts. |
There is also an example `.env.example` file, showing overrides.
## Quirks
### Unraid & Nextcloud database locks
If you're using this to sync files on Unraid, you may encounter weird SQLite database lock issues if you try to use a volume on `/mnt/user/...`. Use `/mnt/cache` where possible to avoid this.
### Nextcloud: Removing all files hangs
If you sync a directory and delete all the files, you'll end up with a console message such as `All the files are going to be changed, asking the user`. The application will hang here permanently. Avoid this by creating a sync'd hidden file such as `.ncignore` (must be non-empty) and leave that in the directory at all times.