itzg / itzg/docker-mc-backup

Readme.md contains confusing suggestions for rclone.conf

Open
#116 4 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Shell
Stars
538
Forks
69
Avg merge
3h 28m
Merged PRs (30d)
2

Description

The Readme.md could use some improvement regarding rclone.conf file. The examples suggest using a file mount, however, rclone requires write access to the file and creates a new temporary file when making updates, so a directory mount seems to be necessary.

There are multiple references:

An example mount is given in the _rclone backup method_ section:
`- ./rclone.config:/config/rclone/rclone.conf:ro`

This is mounting the file itself, however, rclone creates a new temporary file when it edits the rclone.conf file, so a folder mount seems to be necessary. Also, the source file is named rclone.con**fig** and this may be confusing.

Another reference exists in the _Restic with rclone_ section:
```
volumes:
# mount volume pre-configured using a host mounted file
- ./rclone.conf:/config/rclone/rclone.conf
```
It will be helpful to also point out that the mount needs to be mounted rw.

Lastly, a _Troubleshooting_ section that mentions "setting the environment variable `DEBUG` to `true`" may be useful for readers.

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the Readme.md sections named “rclone backup method,” “Restic with rclone,” and “Troubleshooting.” Update the examples and explanatory text to reflect the required writable directory mount, the rclone.conf naming difference, and the DEBUG environment variable guidance. Done means all referenced examples are consistent and no longer suggest an unsuitable read-only file mount.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.