Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Legobas committed May 3, 2024
1 parent 5285211 commit 7d35e0b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ The topic is the same as the Rclone rc url path and the message is the JSON as d
All the `sync/*` commands **will be started as jobs**, MQTT4Rclone will add `"_async":true` to the json message.

The local path in the docker container is `/data`.
This path has to be used in the commands sent to rclone (see examples).

## Examples

```
Expand Down Expand Up @@ -123,17 +126,27 @@ services:
image: legobas/mqtt4rclone:latest
container_name: mqtt4rclone
environment:
- PUID=1000
- PGID=1000
- LOGLEVEL=debug
- RCLONE_LOGLEVEL=INFO
- TZ=Europe/Amsterdam
- PUID=1000 # User id for access to config or data directories with user rights
- PGID=1000 # User group id
- LOGLEVEL=debug # MQTT4Rclone log level: DEBUG/INFO/ERROR
- RCLONE_LOGLEVEL=INFO # Rclone log level: DEBUG/INFO/NOTICE/ERROR
- TZ=America/New_York # Timezone
volumes:
- /home/legobas/mqtt4rclone:/config
- /home/legobas/rclone_data:/data
- /cloud_data:/data
restart: unless-stopped
```
The environment variables are not necessary, if omitted the default values will be used.
## Logging
The logs of mqtt4rclone and rclone are written to stdout, with docker is this the standard docker log.
To view the logging:
`docker compose logs` or `docker logs mqtt4rclone`


## Credits

* [Rclone](https://rclone.org)
Expand Down
4 changes: 2 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ services:
- PGID=1000
- LOGLEVEL=debug
- RCLONE_LOGLEVEL=INFO
- TZ=Europe/Amsterdam
- TZ=America/New_York
volumes:
- /home/legobas/mqtt4rclone:/config
- /home/legobas/rclone_data:/data
- /cloud_data:/data
restart: unless-stopped

0 comments on commit 7d35e0b

Please sign in to comment.