Skip to content

Commit 0d99fa3

Browse files
committed
docs: Update README.md
1 parent c786afc commit 0d99fa3

1 file changed

Lines changed: 23 additions & 5 deletions

File tree

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,18 +61,20 @@ steps:
6161
```
6262

6363
### Config-less operation
64-
You can use Rclone without a config file by using command-line options or environment variables.
64+
You can use Rclone without a config file by using command-line options, environment variables, or connection strings.
6565

6666
```yaml
6767
steps:
6868
- name: Setup Rclone
6969
uses: AnimMouse/setup-rclone@v1
7070
71-
- run: 'rclone lsd --http-url https://beta.rclone.org :http:'
71+
- run: 'rclone lsd --http-url https://pub.rclone.org :http:'
7272
7373
- run: 'rclone lsd :http:'
7474
env:
75-
RCLONE_HTTP_URL: https://beta.rclone.org
75+
RCLONE_HTTP_URL: https://pub.rclone.org
76+
77+
- run: 'rclone lsd ":http,url='https://pub.rclone.org':"'
7678
```
7779

7880
### Plain text Rclone config
@@ -86,12 +88,28 @@ steps:
8688
rclone_config: |
8789
[rclone-test-remote]
8890
type = http
89-
url = https://beta.rclone.org/test/
91+
url = https://pub.rclone.org
9092
disable_base64: true
9193
9294
- run: 'rclone lsd rclone-test-remote:'
9395
```
9496

97+
### Compressed Rclone config
98+
GitHub Actions secrets are limited to 48 KB in size. If you have a large Rclone config file, you can compress it first using zstd.
99+
100+
Compress and encode the rclone.conf file using this command `zstd -c rclone.conf | base64 -w 0` and paste it to `RCLONE_CONFIG` secret.
101+
102+
```yaml
103+
steps:
104+
- name: Setup Rclone
105+
uses: AnimMouse/setup-rclone@v1
106+
with:
107+
rclone_config: ${{ secrets.RCLONE_CONFIG }}
108+
zstd_config: true
109+
110+
- run: rclone copy source:sourcepath dest:destpath
111+
```
112+
95113
### Service account file
96114
To prevent the Rclone config file from becoming too large since you have a lot of remotes that uses the same service account file, use the `AnimMouse/setup-rclone/service-account-file@v1` action to add the service account file inside the Rclone config directory.
97115

@@ -145,7 +163,7 @@ steps:
145163
uses: AnimMouse/setup-rclone@v1
146164
with:
147165
rclone_config: ${{ secrets.RCLONE_CONFIG }}
148-
version: v1.64.0
166+
version: v1.69.0
149167
```
150168

151169
### GitHub token

0 commit comments

Comments
 (0)