Update seaf-fuse document

This commit is contained in:
Daniel Pan 2024-04-24 15:39:13 +08:00
parent 3ca90b7c33
commit 40e90b867f
3 changed files with 10 additions and 16 deletions

View File

@ -1,10 +1,7 @@
# Introduction
Seafile is an open source cloud storage system with file encryption and group sharing.
Seafile is an open source cloud storage system for file sync, share and document collaboration.
Collections of files are called libraries, and each library can be synced separately. A library can be encrypted with a user chosen password. This password is not stored on the server, so even the server admin cannot view a file's contents.
Seafile allows users to create groups with file syncing, a wiki and discussions to enable easy collaboration around documents within a team.
## LICENSE

View File

@ -13,5 +13,5 @@ The API document can be accessed in the following location:
The Admin API document can be accessed in the following location:
* <https://seafile-api.readme.io/> (New)
* <https://download.seafile.com/published/web-api/v2.1-admin>

View File

@ -12,7 +12,7 @@ Note:
* Currently the implementation is '''read-only''', which means you can't modify the files through the mounted folder.
* One debian/centos systems, you need to be in the "fuse" group to have the permission to mount a FUSE folder.
### How to start seaf-fuse
## Use seaf-fuse in binary based deployment
Assume we want to mount to `/data/seafile-fuse`.
@ -30,26 +30,20 @@ Note: Before start seaf-fuse, you should have started seafile server with `./sea
./seaf-fuse.sh start /data/seafile-fuse
```
Since Community server version 4.2.1 and Pro server 4.2.0, the script supports standard mount options for FUSE. For example, you can specify ownership for the mounted folder:
seaf-fuse supports standard mount options for FUSE. For example, you can specify ownership for the mounted folder:
```
./seaf-fuse.sh start -o uid=<uid> /data/seafile-fuse
```
The fuse enables the block cache function by default to cache block objects, thereby reducing access to backend storage, but this function will occupy local disk space. Since Seafile-pro-10.0.0, you can disable block cache by adding following options:
```
./seaf-fuse.sh start --disable-block-cache /data/seafile-fuse
```
You can find the complete list of supported options in `man fuse`.
##### Special notes for used with Ceph
If you use Ceph (via librados) as storage backend, you need to add the `-f` option to seaf-fuse.sh, to ask the fuse program not to daemonize. Otherwise the fuse program will have strange "frozen" behaviors when accessing files.
```
./seaf-fuse.sh start -f /data/seafile-fuse
```
##### Stop seaf-fuse
@ -107,11 +101,13 @@ sudo usermod -a -G fuse <your-user-name>
* Logout your shell and login again
* Now try `./seaf-fuse.sh start <path>`again.
### How to start seaf-fuse in docker
Only support Linux. Assume we want to mount to `/data/seafile-fuse` in host.
## Use seaf-fuse in Docker based deployment
Assume we want to mount to `/data/seafile-fuse` in host.
##### Modify docker-compose.yml
Add the following content
```yml
@ -130,6 +126,7 @@ Add the following content
```
##### Start seaf-fuse with the script in docker
Start Seafile server and enter the container
```bash