github.com/artpar/rclone@v1.67.3/docs/content/seafile.md (about) 1 --- 2 title: "Seafile" 3 description: "Seafile" 4 versionIntroduced: "v1.52" 5 --- 6 7 # {{< icon "fa fa-server" >}} Seafile 8 9 This is a backend for the [Seafile](https://www.seafile.com/) storage service: 10 - It works with both the free community edition or the professional edition. 11 - Seafile versions 6.x, 7.x, 8.x and 9.x are all supported. 12 - Encrypted libraries are also supported. 13 - It supports 2FA enabled users 14 - Using a Library API Token is **not** supported 15 16 ## Configuration 17 18 There are two distinct modes you can setup your remote: 19 - you point your remote to the **root of the server**, meaning you don't specify a library during the configuration: 20 Paths are specified as `remote:library`. You may put subdirectories in too, e.g. `remote:library/path/to/dir`. 21 - you point your remote to a specific library during the configuration: 22 Paths are specified as `remote:path/to/dir`. **This is the recommended mode when using encrypted libraries**. (_This mode is possibly slightly faster than the root mode_) 23 24 ### Configuration in root mode 25 26 Here is an example of making a seafile configuration for a user with **no** two-factor authentication. First run 27 28 rclone config 29 30 This will guide you through an interactive setup process. To authenticate 31 you will need the URL of your server, your email (or username) and your password. 32 33 ``` 34 No remotes found, make a new one? 35 n) New remote 36 s) Set configuration password 37 q) Quit config 38 n/s/q> n 39 name> seafile 40 Type of storage to configure. 41 Enter a string value. Press Enter for the default (""). 42 Choose a number from below, or type in your own value 43 [snip] 44 XX / Seafile 45 \ "seafile" 46 [snip] 47 Storage> seafile 48 ** See help for seafile backend at: https://rclone.org/seafile/ ** 49 50 URL of seafile host to connect to 51 Enter a string value. Press Enter for the default (""). 52 Choose a number from below, or type in your own value 53 1 / Connect to cloud.seafile.com 54 \ "https://cloud.seafile.com/" 55 url> http://my.seafile.server/ 56 User name (usually email address) 57 Enter a string value. Press Enter for the default (""). 58 user> me@example.com 59 Password 60 y) Yes type in my own password 61 g) Generate random password 62 n) No leave this optional password blank (default) 63 y/g> y 64 Enter the password: 65 password: 66 Confirm the password: 67 password: 68 Two-factor authentication ('true' if the account has 2FA enabled) 69 Enter a boolean value (true or false). Press Enter for the default ("false"). 70 2fa> false 71 Name of the library. Leave blank to access all non-encrypted libraries. 72 Enter a string value. Press Enter for the default (""). 73 library> 74 Library password (for encrypted libraries only). Leave blank if you pass it through the command line. 75 y) Yes type in my own password 76 g) Generate random password 77 n) No leave this optional password blank (default) 78 y/g/n> n 79 Edit advanced config? (y/n) 80 y) Yes 81 n) No (default) 82 y/n> n 83 Remote config 84 Two-factor authentication is not enabled on this account. 85 -------------------- 86 [seafile] 87 type = seafile 88 url = http://my.seafile.server/ 89 user = me@example.com 90 pass = *** ENCRYPTED *** 91 2fa = false 92 -------------------- 93 y) Yes this is OK (default) 94 e) Edit this remote 95 d) Delete this remote 96 y/e/d> y 97 ``` 98 99 This remote is called `seafile`. It's pointing to the root of your seafile server and can now be used like this: 100 101 See all libraries 102 103 rclone lsd seafile: 104 105 Create a new library 106 107 rclone mkdir seafile:library 108 109 List the contents of a library 110 111 rclone ls seafile:library 112 113 Sync `/home/local/directory` to the remote library, deleting any 114 excess files in the library. 115 116 rclone sync --interactive /home/local/directory seafile:library 117 118 ### Configuration in library mode 119 120 Here's an example of a configuration in library mode with a user that has the two-factor authentication enabled. Your 2FA code will be asked at the end of the configuration, and will attempt to authenticate you: 121 122 ``` 123 No remotes found, make a new one? 124 n) New remote 125 s) Set configuration password 126 q) Quit config 127 n/s/q> n 128 name> seafile 129 Type of storage to configure. 130 Enter a string value. Press Enter for the default (""). 131 Choose a number from below, or type in your own value 132 [snip] 133 XX / Seafile 134 \ "seafile" 135 [snip] 136 Storage> seafile 137 ** See help for seafile backend at: https://rclone.org/seafile/ ** 138 139 URL of seafile host to connect to 140 Enter a string value. Press Enter for the default (""). 141 Choose a number from below, or type in your own value 142 1 / Connect to cloud.seafile.com 143 \ "https://cloud.seafile.com/" 144 url> http://my.seafile.server/ 145 User name (usually email address) 146 Enter a string value. Press Enter for the default (""). 147 user> me@example.com 148 Password 149 y) Yes type in my own password 150 g) Generate random password 151 n) No leave this optional password blank (default) 152 y/g> y 153 Enter the password: 154 password: 155 Confirm the password: 156 password: 157 Two-factor authentication ('true' if the account has 2FA enabled) 158 Enter a boolean value (true or false). Press Enter for the default ("false"). 159 2fa> true 160 Name of the library. Leave blank to access all non-encrypted libraries. 161 Enter a string value. Press Enter for the default (""). 162 library> My Library 163 Library password (for encrypted libraries only). Leave blank if you pass it through the command line. 164 y) Yes type in my own password 165 g) Generate random password 166 n) No leave this optional password blank (default) 167 y/g/n> n 168 Edit advanced config? (y/n) 169 y) Yes 170 n) No (default) 171 y/n> n 172 Remote config 173 Two-factor authentication: please enter your 2FA code 174 2fa code> 123456 175 Authenticating... 176 Success! 177 -------------------- 178 [seafile] 179 type = seafile 180 url = http://my.seafile.server/ 181 user = me@example.com 182 pass = 183 2fa = true 184 library = My Library 185 -------------------- 186 y) Yes this is OK (default) 187 e) Edit this remote 188 d) Delete this remote 189 y/e/d> y 190 ``` 191 192 You'll notice your password is blank in the configuration. It's because we only need the password to authenticate you once. 193 194 You specified `My Library` during the configuration. The root of the remote is pointing at the 195 root of the library `My Library`: 196 197 See all files in the library: 198 199 rclone lsd seafile: 200 201 Create a new directory inside the library 202 203 rclone mkdir seafile:directory 204 205 List the contents of a directory 206 207 rclone ls seafile:directory 208 209 Sync `/home/local/directory` to the remote library, deleting any 210 excess files in the library. 211 212 rclone sync --interactive /home/local/directory seafile: 213 214 215 ### --fast-list 216 217 Seafile version 7+ supports `--fast-list` which allows you to use fewer 218 transactions in exchange for more memory. See the [rclone 219 docs](/docs/#fast-list) for more details. 220 Please note this is not supported on seafile server version 6.x 221 222 223 ### Restricted filename characters 224 225 In addition to the [default restricted characters set](/overview/#restricted-characters) 226 the following characters are also replaced: 227 228 | Character | Value | Replacement | 229 | --------- |:-----:|:-----------:| 230 | / | 0x2F | ／ | 231 | " | 0x22 | ＂ | 232 | \ | 0x5C | ＼ | 233 234 Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), 235 as they can't be used in JSON strings. 236 237 ### Seafile and rclone link 238 239 Rclone supports generating share links for non-encrypted libraries only. 240 They can either be for a file or a directory: 241 242 ``` 243 rclone link seafile:seafile-tutorial.doc 244 http://my.seafile.server/f/fdcd8a2f93f84b8b90f4/ 245 246 ``` 247 248 or if run on a directory you will get: 249 250 ``` 251 rclone link seafile:dir 252 http://my.seafile.server/d/9ea2455f6f55478bbb0d/ 253 ``` 254 255 Please note a share link is unique for each file or directory. If you run a link command on a file/dir 256 that has already been shared, you will get the exact same link. 257 258 ### Compatibility 259 260 It has been actively developed using the [seafile docker image](https://github.com/haiwen/seafile-docker) of these versions: 261 - 6.3.4 community edition 262 - 7.0.5 community edition 263 - 7.1.3 community edition 264 - 9.0.10 community edition 265 266 Versions below 6.0 are not supported. 267 Versions between 6.0 and 6.3 haven't been tested and might not work properly. 268 269 Each new version of `rclone` is automatically tested against the [latest docker image](https://hub.docker.com/r/seafileltd/seafile-mc/) of the seafile community server. 270 271 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/seafile/seafile.go then run make backenddocs" >}} 272 ### Standard options 273 274 Here are the Standard options specific to seafile (seafile). 275 276 #### --seafile-url 277 278 URL of seafile host to connect to. 279 280 Properties: 281 282 - Config: url 283 - Env Var: RCLONE_SEAFILE_URL 284 - Type: string 285 - Required: true 286 - Examples: 287 - "https://cloud.seafile.com/" 288 - Connect to cloud.seafile.com. 289 290 #### --seafile-user 291 292 User name (usually email address). 293 294 Properties: 295 296 - Config: user 297 - Env Var: RCLONE_SEAFILE_USER 298 - Type: string 299 - Required: true 300 301 #### --seafile-pass 302 303 Password. 304 305 **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/). 306 307 Properties: 308 309 - Config: pass 310 - Env Var: RCLONE_SEAFILE_PASS 311 - Type: string 312 - Required: false 313 314 #### --seafile-2fa 315 316 Two-factor authentication ('true' if the account has 2FA enabled). 317 318 Properties: 319 320 - Config: 2fa 321 - Env Var: RCLONE_SEAFILE_2FA 322 - Type: bool 323 - Default: false 324 325 #### --seafile-library 326 327 Name of the library. 328 329 Leave blank to access all non-encrypted libraries. 330 331 Properties: 332 333 - Config: library 334 - Env Var: RCLONE_SEAFILE_LIBRARY 335 - Type: string 336 - Required: false 337 338 #### --seafile-library-key 339 340 Library password (for encrypted libraries only). 341 342 Leave blank if you pass it through the command line. 343 344 **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/). 345 346 Properties: 347 348 - Config: library_key 349 - Env Var: RCLONE_SEAFILE_LIBRARY_KEY 350 - Type: string 351 - Required: false 352 353 #### --seafile-auth-token 354 355 Authentication token. 356 357 Properties: 358 359 - Config: auth_token 360 - Env Var: RCLONE_SEAFILE_AUTH_TOKEN 361 - Type: string 362 - Required: false 363 364 ### Advanced options 365 366 Here are the Advanced options specific to seafile (seafile). 367 368 #### --seafile-create-library 369 370 Should rclone create a library if it doesn't exist. 371 372 Properties: 373 374 - Config: create_library 375 - Env Var: RCLONE_SEAFILE_CREATE_LIBRARY 376 - Type: bool 377 - Default: false 378 379 #### --seafile-encoding 380 381 The encoding for the backend. 382 383 See the [encoding section in the overview](/overview/#encoding) for more info. 384 385 Properties: 386 387 - Config: encoding 388 - Env Var: RCLONE_SEAFILE_ENCODING 389 - Type: Encoding 390 - Default: Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8 391 392 #### --seafile-description 393 394 Description of the remote 395 396 Properties: 397 398 - Config: description 399 - Env Var: RCLONE_SEAFILE_DESCRIPTION 400 - Type: string 401 - Required: false 402 403 {{< rem autogenerated options stop >}} 404