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