Skip to content

Commit 24a24b7

Browse files
committed
doc: add initial README with usage instructions and environment variables
1 parent 5b8fbd8 commit 24a24b7

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# rclone
2+
3+
A tool for managing files on cloud storage.
4+
5+
## Usage
6+
7+
```sh
8+
docker run --rm -it -v $(pwd)/rclone.conf:/data/rclone.conf:ro \
9+
-e RCLONE_SOURCE=my-source \
10+
-e RCLONE_DESTINATION=my-destination \
11+
-e RCLONE_ARGS="--checksum --max-age 12h --delete-excluded" \
12+
skyloud/rclone sync
13+
```
14+
15+
## Entrypoint Argument
16+
17+
| Argument | Description |
18+
|-----------|-----------------------------------|
19+
| `command` | rclone command (e.g., copy, sync) |
20+
21+
## Environment Variables
22+
23+
| Variable | Description |
24+
|----------------------|-------------------------------------------|
25+
| `RCLONE_CONFIG` | Path to rclone config file |
26+
| `RCLONE_SOURCE` | Source location for rclone operation |
27+
| `RCLONE_DESTINATION` | Destination location for rclone operation |
28+
| `RCLONE_ARGS` | Additional arguments for rclone |
29+
| `HEARTBEAT_URL` | URL for sending heartbeat status |
30+
31+
32+
## Example
33+
34+
```sh
35+
RCLONE_CONFIG=/data/rclone.conf
36+
RCLONE_SOURCE=my-source
37+
RCLONE_DESTINATION=my-destination
38+
RCLONE_ARGS='--checksum'
39+
HEARTBEAT_URL=https://...
40+
```
41+
42+
See [rclone documentation](https://rclone.org/docs/) for more details.

0 commit comments

Comments
 (0)