diff --git a/13.0/404.html b/13.0/404.html index 8de9b329..aa875d54 100644 --- a/13.0/404.html +++ b/13.0/404.html @@ -2230,7 +2230,7 @@
  • - + diff --git a/13.0/administration/account/index.html b/13.0/administration/account/index.html index 27399649..9b5139fa 100644 --- a/13.0/administration/account/index.html +++ b/13.0/administration/account/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/auditing/index.html b/13.0/administration/auditing/index.html index 33f87006..f870cd26 100644 --- a/13.0/administration/auditing/index.html +++ b/13.0/administration/auditing/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/backup_recovery/index.html b/13.0/administration/backup_recovery/index.html index 2aa80a65..7dfc53d3 100644 --- a/13.0/administration/backup_recovery/index.html +++ b/13.0/administration/backup_recovery/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/clean_database/index.html b/13.0/administration/clean_database/index.html index d867be0b..49c0ad9a 100644 --- a/13.0/administration/clean_database/index.html +++ b/13.0/administration/clean_database/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/export_report/index.html b/13.0/administration/export_report/index.html index a0fa66e0..7cd958f6 100644 --- a/13.0/administration/export_report/index.html +++ b/13.0/administration/export_report/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/index.html b/13.0/administration/index.html index e09aeaff..48881052 100644 --- a/13.0/administration/index.html +++ b/13.0/administration/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/logs/index.html b/13.0/administration/logs/index.html index 73c8cf20..f5a19be2 100644 --- a/13.0/administration/logs/index.html +++ b/13.0/administration/logs/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/seafile_fsck/index.html b/13.0/administration/seafile_fsck/index.html index 27cc325b..bf8de6e2 100644 --- a/13.0/administration/seafile_fsck/index.html +++ b/13.0/administration/seafile_fsck/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/seafile_gc/index.html b/13.0/administration/seafile_gc/index.html index 0c30ba15..22be68b6 100644 --- a/13.0/administration/seafile_gc/index.html +++ b/13.0/administration/seafile_gc/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/security_features/index.html b/13.0/administration/security_features/index.html index b58e11d0..61bc8add 100644 --- a/13.0/administration/security_features/index.html +++ b/13.0/administration/security_features/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/administration/two_factor_authentication/index.html b/13.0/administration/two_factor_authentication/index.html index 78e04680..c5905c00 100644 --- a/13.0/administration/two_factor_authentication/index.html +++ b/13.0/administration/two_factor_authentication/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/changelog/changelog-for-seafile-professional-server-old/index.html b/13.0/changelog/changelog-for-seafile-professional-server-old/index.html index 82a8432f..c0c4e353 100644 --- a/13.0/changelog/changelog-for-seafile-professional-server-old/index.html +++ b/13.0/changelog/changelog-for-seafile-professional-server-old/index.html @@ -2237,7 +2237,7 @@
  • - + diff --git a/13.0/changelog/changelog-for-seafile-professional-server/index.html b/13.0/changelog/changelog-for-seafile-professional-server/index.html index 6d0ee23a..a53625cb 100644 --- a/13.0/changelog/changelog-for-seafile-professional-server/index.html +++ b/13.0/changelog/changelog-for-seafile-professional-server/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/changelog/client-changelog/index.html b/13.0/changelog/client-changelog/index.html index c7fbe466..71cf00fb 100644 --- a/13.0/changelog/client-changelog/index.html +++ b/13.0/changelog/client-changelog/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/changelog/drive-client-changelog/index.html b/13.0/changelog/drive-client-changelog/index.html index 12d2caa2..e3742e98 100644 --- a/13.0/changelog/drive-client-changelog/index.html +++ b/13.0/changelog/drive-client-changelog/index.html @@ -2241,7 +2241,7 @@
  • - + diff --git a/13.0/changelog/index.html b/13.0/changelog/index.html index c18a716f..007a2ccb 100644 --- a/13.0/changelog/index.html +++ b/13.0/changelog/index.html @@ -2237,7 +2237,7 @@
  • - + diff --git a/13.0/changelog/server-changelog-old/index.html b/13.0/changelog/server-changelog-old/index.html index 481f23e0..b396037e 100644 --- a/13.0/changelog/server-changelog-old/index.html +++ b/13.0/changelog/server-changelog-old/index.html @@ -2237,7 +2237,7 @@
  • - + diff --git a/13.0/changelog/server-changelog/index.html b/13.0/changelog/server-changelog/index.html index c6a12068..883b632d 100644 --- a/13.0/changelog/server-changelog/index.html +++ b/13.0/changelog/server-changelog/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/config/admin_roles_permissions/index.html b/13.0/config/admin_roles_permissions/index.html index b79a078f..0c3ff72f 100644 --- a/13.0/config/admin_roles_permissions/index.html +++ b/13.0/config/admin_roles_permissions/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/auth_switch/index.html b/13.0/config/auth_switch/index.html index f419a433..2a3dbf7d 100644 --- a/13.0/config/auth_switch/index.html +++ b/13.0/config/auth_switch/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/auto_login_seadrive/index.html b/13.0/config/auto_login_seadrive/index.html index c28993c7..30d655a0 100644 --- a/13.0/config/auto_login_seadrive/index.html +++ b/13.0/config/auto_login_seadrive/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/ccnet-conf/index.html b/13.0/config/ccnet-conf/index.html index cb6ce001..ad42875e 100644 --- a/13.0/config/ccnet-conf/index.html +++ b/13.0/config/ccnet-conf/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/config_seafile_with_ADFS/index.html b/13.0/config/config_seafile_with_ADFS/index.html index 64c2260c..780ebe08 100644 --- a/13.0/config/config_seafile_with_ADFS/index.html +++ b/13.0/config/config_seafile_with_ADFS/index.html @@ -2237,7 +2237,7 @@
  • - + diff --git a/13.0/config/customize_email_notifications/index.html b/13.0/config/customize_email_notifications/index.html index 81f845ea..f7de8b85 100644 --- a/13.0/config/customize_email_notifications/index.html +++ b/13.0/config/customize_email_notifications/index.html @@ -2237,7 +2237,7 @@
  • - + diff --git a/13.0/config/details_about_file_search/index.html b/13.0/config/details_about_file_search/index.html index 98c61f18..94f24633 100644 --- a/13.0/config/details_about_file_search/index.html +++ b/13.0/config/details_about_file_search/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/env/index.html b/13.0/config/env/index.html index ab0064a7..e30e7eca 100644 --- a/13.0/config/env/index.html +++ b/13.0/config/env/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/index.html b/13.0/config/index.html index c713d71e..5e09b81a 100644 --- a/13.0/config/index.html +++ b/13.0/config/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/ldap_in_ce/index.html b/13.0/config/ldap_in_ce/index.html index 64c9c1df..4fb2a973 100644 --- a/13.0/config/ldap_in_ce/index.html +++ b/13.0/config/ldap_in_ce/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/ldap_in_pro/index.html b/13.0/config/ldap_in_pro/index.html index a01053ef..15277055 100644 --- a/13.0/config/ldap_in_pro/index.html +++ b/13.0/config/ldap_in_pro/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/multi_institutions/index.html b/13.0/config/multi_institutions/index.html index 9ae7db6b..7fed515b 100644 --- a/13.0/config/multi_institutions/index.html +++ b/13.0/config/multi_institutions/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/multi_tenancy/index.html b/13.0/config/multi_tenancy/index.html index 6792d6a4..a646d910 100644 --- a/13.0/config/multi_tenancy/index.html +++ b/13.0/config/multi_tenancy/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/oauth/index.html b/13.0/config/oauth/index.html index ef3c1cc5..15812838 100644 --- a/13.0/config/oauth/index.html +++ b/13.0/config/oauth/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/ocm/index.html b/13.0/config/ocm/index.html index 35c84b1d..4689c8eb 100644 --- a/13.0/config/ocm/index.html +++ b/13.0/config/ocm/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/remote_user/index.html b/13.0/config/remote_user/index.html index 27443112..4528407d 100644 --- a/13.0/config/remote_user/index.html +++ b/13.0/config/remote_user/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/roles_permissions/index.html b/13.0/config/roles_permissions/index.html index 8de2dff9..9133655f 100644 --- a/13.0/config/roles_permissions/index.html +++ b/13.0/config/roles_permissions/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/saml2/index.html b/13.0/config/saml2/index.html index 7686751b..99336d19 100644 --- a/13.0/config/saml2/index.html +++ b/13.0/config/saml2/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/seafevents-conf/index.html b/13.0/config/seafevents-conf/index.html index 787d6610..1088b32c 100644 --- a/13.0/config/seafevents-conf/index.html +++ b/13.0/config/seafevents-conf/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/seafile-conf/index.html b/13.0/config/seafile-conf/index.html index 2c4467ce..2dc6225c 100644 --- a/13.0/config/seafile-conf/index.html +++ b/13.0/config/seafile-conf/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/seahub_customization/index.html b/13.0/config/seahub_customization/index.html index 71ea8add..874ee451 100644 --- a/13.0/config/seahub_customization/index.html +++ b/13.0/config/seahub_customization/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/seahub_settings_py/index.html b/13.0/config/seahub_settings_py/index.html index 6463e159..9d39c5ae 100644 --- a/13.0/config/seahub_settings_py/index.html +++ b/13.0/config/seahub_settings_py/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/sending_email/index.html b/13.0/config/sending_email/index.html index 08af3992..4db85fcc 100644 --- a/13.0/config/sending_email/index.html +++ b/13.0/config/sending_email/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/shibboleth_authentication/index.html b/13.0/config/shibboleth_authentication/index.html index 3329d6c4..9e69b72e 100644 --- a/13.0/config/shibboleth_authentication/index.html +++ b/13.0/config/shibboleth_authentication/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/config/single_sign_on/index.html b/13.0/config/single_sign_on/index.html index 100baf4b..a895f55c 100644 --- a/13.0/config/single_sign_on/index.html +++ b/13.0/config/single_sign_on/index.html @@ -2247,7 +2247,7 @@
  • - + diff --git a/13.0/develop/build_seafile/index.html b/13.0/develop/build_seafile/index.html index c51ea7de..746004f5 100644 --- a/13.0/develop/build_seafile/index.html +++ b/13.0/develop/build_seafile/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/develop/data_model/index.html b/13.0/develop/data_model/index.html index 9e89be5a..32a517f8 100644 --- a/13.0/develop/data_model/index.html +++ b/13.0/develop/data_model/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/develop/index.html b/13.0/develop/index.html index f73903dd..60d9a8d8 100644 --- a/13.0/develop/index.html +++ b/13.0/develop/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/develop/linux/index.html b/13.0/develop/linux/index.html index 6e3d1c81..30c9e8e9 100644 --- a/13.0/develop/linux/index.html +++ b/13.0/develop/linux/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/develop/osx/index.html b/13.0/develop/osx/index.html index 70b93102..e0053342 100644 --- a/13.0/develop/osx/index.html +++ b/13.0/develop/osx/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/develop/rpi/index.html b/13.0/develop/rpi/index.html index 83103c0c..ce9081b5 100644 --- a/13.0/develop/rpi/index.html +++ b/13.0/develop/rpi/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/develop/server/index.html b/13.0/develop/server/index.html index b17f6f3d..af7bd196 100644 --- a/13.0/develop/server/index.html +++ b/13.0/develop/server/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/develop/translation/index.html b/13.0/develop/translation/index.html index f8ffe6fc..3f19a53b 100644 --- a/13.0/develop/translation/index.html +++ b/13.0/develop/translation/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/develop/web_api_v2.1/index.html b/13.0/develop/web_api_v2.1/index.html index 4f66aa43..db31e7fd 100644 --- a/13.0/develop/web_api_v2.1/index.html +++ b/13.0/develop/web_api_v2.1/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/develop/windows/index.html b/13.0/develop/windows/index.html index a6072d7a..b094d099 100644 --- a/13.0/develop/windows/index.html +++ b/13.0/develop/windows/index.html @@ -2243,7 +2243,7 @@
  • - + diff --git a/13.0/extension/distributed_indexing/index.html b/13.0/extension/distributed_indexing/index.html index 81821e8e..d1699434 100644 --- a/13.0/extension/distributed_indexing/index.html +++ b/13.0/extension/distributed_indexing/index.html @@ -2253,7 +2253,7 @@
  • - + diff --git a/13.0/extension/fuse/index.html b/13.0/extension/fuse/index.html index becb6b1c..994e3e5e 100644 --- a/13.0/extension/fuse/index.html +++ b/13.0/extension/fuse/index.html @@ -16,7 +16,7 @@ - + @@ -2330,7 +2330,7 @@
  • - + @@ -4836,7 +4836,7 @@ drwxr-xr-x 2 root root 1.6K Jan 1 1970 a09ab9fc-7bd0-49f1-929d-6abeb8491397_My - +
    Next diff --git a/13.0/extension/libreoffice_online/index.html b/13.0/extension/libreoffice_online/index.html index 7dbfea3d..f0abcc79 100644 --- a/13.0/extension/libreoffice_online/index.html +++ b/13.0/extension/libreoffice_online/index.html @@ -13,7 +13,7 @@ - + @@ -2253,7 +2253,7 @@
  • - + @@ -4871,7 +4871,7 @@ docker compose up
    • + +
  • + + + Deploy face embedding service (Optional) + + + + +
    • @@ -4644,14 +4728,14 @@
  • Detect text in images (OCR)

    • Deploy Seafile AI basic service

    -

    The Seafile AI basic service will use API calls to external large language model service (e.g., GPT-4o-mini) to implement file labeling, file and image summaries, text translation, and sdoc writing assistance.

    +

    The Seafile AI basic service will use API calls to external large language model service to implement file labeling, file and image summaries, text translation, and sdoc writing assistance.

    1. Download seafile-ai.yml

      wget https://manual.seafile.com/13.0/repo/docker/seafile-ai.yml
      -

      Deploy in a cluster

      +

      Deploy in a cluster or standalone deployment

      If you deploy Seafile in a cluster and would like to deploy Seafile AI, please expose port 8888 in seafile-ai.yml:

      services:
   seafile-ai:
@@ -4667,13 +4751,25 @@
 
      COMPOSE_FILE='...,seafile-ai.yml' # add seafile-ai.yml
 
 ENABLE_SEAFILE_AI=true
-SEAFILE_AI_LLM_TYPE=open-ai
-SEAFILE_AI_LLM_URL=<your LLM endpoint URL>
 SEAFILE_AI_LLM_KEY=<your LLM access key>
 
      
 
      
-
      Deploy in a cluster
      
-
      Please also specify SEAFILE_AI_SERVER_URL to the host where deploys your Seafile AI basic service in .env, if you deploy Seafile in a cluster.
      
+
      Deploy in a cluster or standalone deployment
      
+
      Please also specify the following items in .env:
      
+
        
+
      • .env on the host where deploys Seafile server:
        • 
+
      • SEAFILE_AI_SERVER_URL: the service url of Seafile AI (e.g., http://seafile-ai.example.com:8888)
        • 
+
      • .env on the host where deploys Seafile AI:
+  SEAFILE_SERVER_URL: your Seafile server's url (e.g., https://seafile.example.com)
        • 
+
      
+
      
+
      
+
      About LLM configs
      
+
      By default, Seafile uses the GPT-4o-mini model from OpenAI. You only need to provide your OpenAI API Key. If you need to use other LLM (including self-deployed LLM service), you also need to specify the following in .env:
      
+
      SEAFILE_AI_LLM_TYPE=<your LLM type>
+SEAFILE_AI_LLM_URL=<your LLM endpoint>
+SEAFILE_AI_LLM_KEY=<your LLM API key>
+
    2. @@ -4683,6 +4779,107 @@ docker compose up
    +

    Deploy face embedding service (Optional)

    +

    The Face Embedding service is used to detect and encode faces in images. Generally, we recommend that you deploy the service on a machine with a GPU and a graphics card driver that supports OnnxRuntime (so it can also be deployed on a different machine from the Seafile AI base service). Currently, the Seafile AI Face Embedding service only supports the following modes:

    + + + +

    If you plan to deploy these face embeddings in an environment using a GPU, you need to make sure your graphics card is in the range supported by the acceleration environment and correctly mapped in /dev/dri directory (so cloud servers and WSL under certain driver versions will not be supported).

    +
      +
    1. +

      Download Docker compose files

      +
      +
      +
      +
      wget -O face-embedding.yml https://manual.seafile.com/13.0/repo/docker/face-embedding/cuda.yml
+
      +
      +
      +
      wget -O face-embedding.yml https://manual.seafile.com/13.0/repo/docker/face-embedding/cpu.yml
+
      +
      +
      +
      +
      2. +
    + + +
      +
    1. +

      Modify .env, insert or modify the following fields:

      +
      COMPOSE_FILE='...,face-embedding.yml' # add face-embedding.yml
+
+FACE_EMBEDDING_VOLUME=/opt/face_embedding
+
      +
      2. +
    2. +

      Restart Seafile server

      +
      docker compose down
+docker compose up -d
+
      +
      3. +
    3. +

      Enable face recognition in the repo's settings:

      +

      Enable face recognition

      +
      4. +
    +

    Deploy the face embedding service on a different machine than the Seafile AI basic service

    +

    Since the face embedding service may need to be deployed on some hosts with GPU(s), it may not be deployed together with the Seafile AI basic service. At this time, you should make some changes to the Docker compose file so that the service can be accessed normally.

    +
      +
    1. +

      Modify .yml file, delete the commented out lines to expose the service port:

      +
      services:
+    face-embedding:
+    ...
+    ports:
+        - 8886:8886
+
      +
      2. +
    2. +

      Modify the .env of the Seafile AI basic service:

      +
      FACE_EMBEDDING_SERVICE_URL=http://<your face embedding service host>:8886
+
      +
      3. +
    3. +

      Make sure JWT_PRIVATE_KEY has set in the .env for face embedding and is same as the Seafile server

      +
      4. +
    4. +

      Restart Seafile server

      +
      docker compose down
+docker compose up -d
+
      +
      5. +
    +

    Persistent volume and model management

    +

    By default, the persistent volume is /opt/face_embedding. It will consist of two subdirectories:

    + +

    Customizing model serving access keys

    +

    By default, the access key used by the face embedding is the same as that used by the Seafile server, which is JWT_PRIVATE_KEY. At some point, this will have to be modified for security reasons. If you need to customize the access key for the face embedding, you can do the following steps:

    +
      +
    1. +

      Modify .env file for both face embedding and Seafile AI:

      +
      FACE_EMBEDDING_SERVICE_KEY=<your customizing access keys>
+
      +
      2. +
    2. +

      Restart Seafile server

      +
      docker compose down
+docker compose up -d
+
      +
      3. +
    diff --git a/13.0/extension/setup_seadoc/index.html b/13.0/extension/setup_seadoc/index.html index d7e9da3d..14b1a1d0 100644 --- a/13.0/extension/setup_seadoc/index.html +++ b/13.0/extension/setup_seadoc/index.html @@ -2375,7 +2375,7 @@
  • - + diff --git a/13.0/extension/thumbnail-server/index.html b/13.0/extension/thumbnail-server/index.html index b15f291e..6fed36a4 100644 --- a/13.0/extension/thumbnail-server/index.html +++ b/13.0/extension/thumbnail-server/index.html @@ -2324,7 +2324,7 @@
  • - + diff --git a/13.0/extension/virus_scan/index.html b/13.0/extension/virus_scan/index.html index 21c60259..2f8c8bed 100644 --- a/13.0/extension/virus_scan/index.html +++ b/13.0/extension/virus_scan/index.html @@ -2253,7 +2253,7 @@
  • - + diff --git a/13.0/extension/virus_scan_with_clamav/index.html b/13.0/extension/virus_scan_with_clamav/index.html index d73465a6..e4af70ce 100644 --- a/13.0/extension/virus_scan_with_clamav/index.html +++ b/13.0/extension/virus_scan_with_clamav/index.html @@ -2253,7 +2253,7 @@
  • - + diff --git a/13.0/extension/virus_scan_with_kav4fs/index.html b/13.0/extension/virus_scan_with_kav4fs/index.html index 372c3b32..ad100003 100644 --- a/13.0/extension/virus_scan_with_kav4fs/index.html +++ b/13.0/extension/virus_scan_with_kav4fs/index.html @@ -2253,7 +2253,7 @@
  • - + diff --git a/13.0/extension/webdav/index.html b/13.0/extension/webdav/index.html index 33bb0c5f..75b4607f 100644 --- a/13.0/extension/webdav/index.html +++ b/13.0/extension/webdav/index.html @@ -2375,7 +2375,7 @@
  • - + diff --git a/13.0/images/face-embedding.png b/13.0/images/face-embedding.png new file mode 100644 index 00000000..cacf32da Binary files /dev/null and b/13.0/images/face-embedding.png differ diff --git a/13.0/images/seafile-ai-file-tags.png b/13.0/images/seafile-ai-file-tags.png deleted file mode 100644 index 0cee511b..00000000 Binary files a/13.0/images/seafile-ai-file-tags.png and /dev/null differ diff --git a/13.0/index.html b/13.0/index.html index 14215dea..694e6f01 100644 --- a/13.0/index.html +++ b/13.0/index.html @@ -2306,7 +2306,7 @@
  • - + diff --git a/13.0/introduction/components/index.html b/13.0/introduction/components/index.html index 8aab76b1..2f470ec3 100644 --- a/13.0/introduction/components/index.html +++ b/13.0/introduction/components/index.html @@ -2258,7 +2258,7 @@
  • - + diff --git a/13.0/introduction/contribution/index.html b/13.0/introduction/contribution/index.html index 76a061c7..3b2e4f12 100644 --- a/13.0/introduction/contribution/index.html +++ b/13.0/introduction/contribution/index.html @@ -2317,7 +2317,7 @@
  • - + diff --git a/13.0/introduction/file_permission_management/index.html b/13.0/introduction/file_permission_management/index.html index ba351641..4f2df822 100644 --- a/13.0/introduction/file_permission_management/index.html +++ b/13.0/introduction/file_permission_management/index.html @@ -2308,7 +2308,7 @@
  • - + diff --git a/13.0/introduction/roadmap/index.html b/13.0/introduction/roadmap/index.html index acb699df..191b2a6f 100644 --- a/13.0/introduction/roadmap/index.html +++ b/13.0/introduction/roadmap/index.html @@ -2258,7 +2258,7 @@
  • - + diff --git a/13.0/repo/docker/face-embedding/cpu.yml b/13.0/repo/docker/face-embedding/cpu.yml new file mode 100644 index 00000000..48724782 --- /dev/null +++ b/13.0/repo/docker/face-embedding/cpu.yml @@ -0,0 +1,16 @@ +services: + face-embedding: + image: ${FACE_EMBEDDING_IMAGE:-seafileltd/face-embedding:latest-cpu} + container_name: face-embedding + # ports: + # - 8886:8886 + volumes: + - ${FACE_EMBEDDING_VOLUME:-/opt/face_embedding}/models:/models + - ${FACE_EMBEDDING_VOLUME:-/opt/face_embedding}/logs:/logs + environment: + - FACE_EMBEDDING_SERVICE_KEY=${FACE_EMBEDDING_SERVICE_KEY:-${JWT_PRIVATE_KEY:?JWT_PRIVATE_KEY is not set or empty}} + networks: + - seafile-net +networks: + seafile-net: + name: seafile-net diff --git a/13.0/repo/docker/face-embedding/cuda.yml b/13.0/repo/docker/face-embedding/cuda.yml new file mode 100644 index 00000000..6d019335 --- /dev/null +++ b/13.0/repo/docker/face-embedding/cuda.yml @@ -0,0 +1,26 @@ +services: + face-embedding: + image: ${FACE_EMBEDDING_IMAGE:-seafileltd/face-embedding:latest-cuda} + container_name: face-embedding + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: all + capabilities: [gpu] + # ports: + # - 8886:8886 + devices: + - "/dev/dri:/dev/dri" + volumes: + - ${FACE_EMBEDDING_VOLUME:-/opt/face_embedding}/models:/models + - ${FACE_EMBEDDING_VOLUME:-/opt/face_embedding}/logs:/logs + environment: + - FACE_EMBEDDING_SERVICE_KEY=${FACE_EMBEDDING_SERVICE_KEY:-${JWT_PRIVATE_KEY:?Variable is not set or empty}} + networks: + - seafile-net + +networks: + seafile-net: + name: seafile-net diff --git a/13.0/repo/docker/face-embedding/rocm.yml b/13.0/repo/docker/face-embedding/rocm.yml new file mode 100644 index 00000000..261bebcf --- /dev/null +++ b/13.0/repo/docker/face-embedding/rocm.yml @@ -0,0 +1,19 @@ +services: + face-embedding: + image: ${FACE_EMBEDDING_IMAGE:-seafileltd/face-embedding:latest-rocm} + container_name: face-embedding + ports: + - 8886:8886 + devices: + - "/dev/kfd:/dev/kfd" + volumes: + - ${FACE_EMBEDDING_VOLUME:-/opt/face_embedding}/models:/models + - ${FACE_EMBEDDING_VOLUME:-/opt/face_embedding}/logs:/logs + environment: + - FACE_EMBEDDING_SERVICE_KEY=${FACE_EMBEDDING_SERVICE_KEY:-${JWT_PRIVATE_KEY:?Variable is not set or empty}} + networks: + - seafile-net + +networks: + seafile-net: + name: seafile-net diff --git a/13.0/repo/docker/seadoc/0.8/docker-compose.yml b/13.0/repo/docker/seadoc/0.8/docker-compose.yml deleted file mode 100644 index 726e086f..00000000 --- a/13.0/repo/docker/seadoc/0.8/docker-compose.yml +++ /dev/null @@ -1,22 +0,0 @@ -services: - - sdoc-server: - image: seafileltd/sdoc-server:0.8.0 - container_name: sdoc-server - ports: - - 80:80 - # - 443:443 - # - 7070:7070 - # - 8888:8888 - volumes: - - /opt/seadoc-data/:/shared - environment: - - DB_HOST=192.168.0.2 - - DB_PORT=3306 - - DB_USER=user - - DB_PASSWD=password # Required, password of MySQL service. - - DB_NAME=sdoc_db - - TIME_ZONE=Etc/UTC # Optional, default is UTC. Should be uncomment and set to your local time zone. - - SDOC_SERVER_LETSENCRYPT=false # Whether to use https or not. - - SDOC_SERVER_HOSTNAME=sdoc-server.example.com # Specifies your host name if https is enabled. - - SEAHUB_SERVICE_URL=http://seafile.example.com diff --git a/13.0/repo/docker/seafile-ai.yml b/13.0/repo/docker/seafile-ai.yml index b120153b..dd9f163e 100644 --- a/13.0/repo/docker/seafile-ai.yml +++ b/13.0/repo/docker/seafile-ai.yml @@ -5,23 +5,19 @@ services: volumes: - ${SEAFILE_VOLUME:-/opt/seafile-data}:/shared # ports: - # - 8888:8888 + # - 8888:8888 environment: - - JWT_PRIVATE_KEY=${JWT_PRIVATE_KEY:?Variable is not set or empty} - - IMAGE_TAGS_SERVICE_KEY=${IMAGE_TAGS_SERVICE_KEY:-} - - FACE_EMBEDDING_SERVICE_KEY=${FACE_EMBEDDING_SERVICE_KEY:-} - - OCR_SERVICE_KEY=${OCR_SERVICE_KEY:-} - - SEAFILE_AI_LLM_TYPE=${SEAFILE_AI_LLM_TYPE:-open-ai} - - SEAFILE_AI_LLM_URL=$SEAFILE_AI_LLM_URL - - SEAFILE_AI_LLM_KEY=$SEAFILE_AI_LLM_KEY - - IMAGE_TAGS_SERVICE_URL=${IMAGE_TAGS_SERVICE_URL:-http://image-tags:8885} + - SEAFILE_AI_LLM_TYPE=${SEAFILE_AI_LLM_TYPE:-openai} + - SEAFILE_AI_LLM_URL=${SEAFILE_AI_LLM_URL:-} + - SEAFILE_AI_LLM_KEY=${SEAFILE_AI_LLM_KEY:-} - FACE_EMBEDDING_SERVICE_URL=${FACE_EMBEDDING_SERVICE_URL:-http://face-embedding:8886} - - OCR_SERVICE_URL=${OCR_SERVICE_URL:-http://ocr:8887} - - SEAFILE_SERVER_HOSTNAME=${SEAFILE_SERVER_HOSTNAME:?Variable is not set or empty} - - SEAFILE_SERVER_PROTOCOL=${SEAFILE_SERVER_PROTOCOL:-http} + - FACE_EMBEDDING_SERVICE_KEY=${FACE_EMBEDDING_SERVICE_KEY:-${JWT_PRIVATE_KEY:?Variable is not set or empty}} + - SEAFILE_SERVER_URL=${SEAFILE_SERVER_URL:-http://seafile} + - JWT_PRIVATE_KEY=${JWT_PRIVATE_KEY:?Variable is not set or empty} + - SEAFILE_AI_LOG_LEVEL=${SEAFILE_AI_LOG_LEVEL:-info} networks: - seafile-net networks: seafile-net: - name: seafile-net \ No newline at end of file + name: seafile-net diff --git a/13.0/search/search_index.json b/13.0/search/search_index.json index 8f77caba..40eadd35 100644 --- a/13.0/search/search_index.json +++ b/13.0/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Introduction","text":"

    Seafile 13.0

    Our document of Seafile 13.0 is still in progress, the updates of some key components have not been completed yet. Please refer to Seafile 12.0 for more stable support.

    Seafile is an open source cloud storage system for file sync, share and document collaboration. SeaDoc is an extension of Seafile that providing a lightweight online collaborative document feature.

    "},{"location":"#license","title":"LICENSE","text":"

    The different components of Seafile project are released under different licenses:

    "},{"location":"#contact-information","title":"Contact information","text":""},{"location":"changelog/","title":"Changelog","text":""},{"location":"changelog/#changelogs","title":"Changelogs","text":""},{"location":"administration/","title":"Administration","text":""},{"location":"administration/#enter-the-admin-panel","title":"Enter the admin panel","text":"

    As the system admin, you can enter the admin panel by click System Admin in the popup of avatar.

    "},{"location":"administration/#account-management","title":"Account management","text":""},{"location":"administration/#logs","title":"Logs","text":""},{"location":"administration/#backup-and-recovery","title":"Backup and Recovery","text":"

    Backup and recovery:

    Recover corrupt files after server hard shutdown or system crash:

    You can run Seafile GC to remove unused files:

    "},{"location":"administration/#clean-database","title":"Clean database","text":""},{"location":"administration/#export-report","title":"Export report","text":""},{"location":"administration/account/","title":"Account Management","text":""},{"location":"administration/account/#user-management","title":"User Management","text":"

    When you setup seahub website, you should have setup a admin account. After you logged in a admin, you may add/delete users and file libraries.

    "},{"location":"administration/account/#how-to-change-a-users-id","title":"How to change a user's ID","text":"

    Since version 11.0, if you need to change a user's external ID, you can manually modify database table social_auth_usersocialauth to map the new external ID to internal ID.

    "},{"location":"administration/account/#resetting-user-password","title":"Resetting User Password","text":"

    Administrator can reset password for a user in \"System Admin\" page.

    In a private server, the default settings doesn't support users to reset their password by email. If you want to enable this, you have first to set up notification email.

    "},{"location":"administration/account/#forgot-admin-account-or-password","title":"Forgot Admin Account or Password?","text":"

    You may run reset-admin.sh script under seafile-server-latest directory. This script would help you reset the admin account and password. Your data will not be deleted from the admin account, this only unlocks and changes the password for the admin account.

    Tip

    Enter into the docker image, then go to /opt/seafile/seafile-server-latest

    "},{"location":"administration/account/#user-quota-notice","title":"User Quota Notice","text":"

    Under the seafile-server-latest directory, run ./seahub.sh python-env python seahub/manage.py check_user_quota , when the user quota exceeds 90%, an email will be sent. If you want to enable this, you have first to set up notification email.

    "},{"location":"administration/auditing/","title":"Access log and auditing (Pro)","text":"

    In the Pro Edition, Seafile offers four audit logs in system admin panel:

    The audit log data is saved in seahub_db.

    "},{"location":"administration/backup_recovery/","title":"Backup and Recovery","text":""},{"location":"administration/backup_recovery/#overview","title":"Overview","text":"

    There are generally two parts of data to backup

    There are 3 databases:

    "},{"location":"administration/backup_recovery/#backup-steps","title":"Backup steps","text":"

    The backup is a two step procedure:

    1. Backup the databases;
    2. Backup the seafile data directory;
    "},{"location":"administration/backup_recovery/#backup-order-database-first-or-data-directory-first","title":"Backup Order: Database First or Data Directory First","text":"

    The second sequence is better in the sense that it avoids library corruption. Like other backup solutions, some new data can be lost in recovery. There is always a backup window. However, if your storage backup mechanism can finish quickly enough, using the first sequence can retain more data.

    We assume your seafile data directory is in /opt/seafile for binary package based deployment (or /opt/seafile-data for docker based deployment). And you want to backup to /backup directory. The /backup can be an NFS or Windows share mount exported by another machine, or just an external disk. You can create a layout similar to the following in /backup directory:

    /backup\n---- databases/  contains database backup files\n---- data/  contains backups of the data directory\n
    "},{"location":"administration/backup_recovery/#backup-and-restore-for-binary-package-based-deployment","title":"Backup and restore for binary package based deployment","text":""},{"location":"administration/backup_recovery/#backing-up-databases","title":"Backing up Databases","text":"

    It's recommended to backup the database to a separate file each time. Don't overwrite older database backups for at least a week.

    Assume your database names are ccnet_db, seafile_db and seahub_db. mysqldump automatically locks the tables so you don't need to stop Seafile server when backing up MySQL databases. Since the database tables are usually very small, it won't take long to dump.

    mysqldump -h [mysqlhost] -u[username] -p[password] --opt ccnet_db > /backup/databases/ccnet_db.sql.`date +\"%Y-%m-%d-%H-%M-%S\"`\n\nmysqldump -h [mysqlhost] -u[username] -p[password] --opt seafile_db > /backup/databases/seafile_db.sql.`date +\"%Y-%m-%d-%H-%M-%S\"`\n\nmysqldump -h [mysqlhost] -u[username] -p[password] --opt seahub_db > /backup/databases/seahub_db.sql.`date +\"%Y-%m-%d-%H-%M-%S\"`\n

    mysqldump: command not found

    You may encounter this problem on some machines with a minimal (from 10.5) or a newer (from 11.0) Mariadb server installed, of which the mysql* series of commands have been gradually deprecated. If you encounter this error, use the mariadb-dump command, such as:

    mariadb-dump -h [mysqlhost] -u[username] -p[password] --opt ccnet_db > /backup/databases/ccnet_db.sql.`date +\"%Y-%m-%d-%H-%M-%S\"`\n\nmariadb-dump -h [mysqlhost] -u[username] -p[password] --opt seafile_db > /backup/databases/seafile_db.sql.`date +\"%Y-%m-%d-%H-%M-%S\"`\n\nmariadb-dump -h [mysqlhost] -u[username] -p[password] --opt seahub_db > /backup/databases/seahub_db.sql.`date +\"%Y-%m-%d-%H-%M-%S\"`\n
    "},{"location":"administration/backup_recovery/#backing-up-seafile-library-data","title":"Backing up Seafile library data","text":"

    The data files are all stored in the /opt/seafile directory, so just back up the whole directory. You can directly copy the whole directory to the backup destination, or you can use rsync to do incremental backup.

    To directly copy the whole data directory,

    cp -R /opt/seafile /backup/data/seafile-`date +\"%Y-%m-%d-%H-%M-%S\"`\n

    This produces a separate copy of the data directory each time. You can delete older backup copies after a new one is completed.

    If you have a lot of data, copying the whole data directory would take long. You can use rsync to do incremental backup.

    rsync -az /opt/seafile /backup/data\n

    This command backup the data directory to /backup/data/seafile.

    "},{"location":"administration/backup_recovery/#restore-from-backup","title":"Restore from backup","text":"

    Now supposed your primary seafile server is broken, you're switching to a new machine. Using the backup data to restore your Seafile instance:

    1. Copy /backup/data/seafile to the new machine. Let's assume the seafile deployment location new machine is also /opt/seafile.
    2. Restore the database.
    3. Since database and data are backed up separately, they may become a little inconsistent with each other. To correct the potential inconsistency, run seaf-fsck tool to check data integrity on the new machine. See seaf-fsck documentation.
    "},{"location":"administration/backup_recovery/#restore-the-databases","title":"Restore the databases","text":"

    Now with the latest valid database backup files at hand, you can restore them.

    mysql -u[username] -p[password] ccnet_db < ccnet_db.sql.2013-10-19-16-00-05\nmysql -u[username] -p[password] seafile_db < seafile_db.sql.2013-10-19-16-00-20\nmysql -u[username] -p[password] seahub_db < seahub_db.sql.2013-10-19-16-01-05\n

    mysql: command not found

    You may encounter this problem on some machines with a minimal (from 10.5) or a newer (from 11.0) Mariadb server installed, of which the mysql* series of commands have been gradually deprecated. If you encounter this error, use the mariadb command, such as:

    mariadb -u[username] -p[password] ccnet_db < ccnet_db.sql.2013-10-19-16-00-05\nmariadb -u[username] -p[password] seafile_db < seafile_db.sql.2013-10-19-16-00-20\nmariadb -u[username] -p[password] seahub_db < seahub_db.sql.2013-10-19-16-01-05\n
    "},{"location":"administration/backup_recovery/#backup-and-restore-for-docker-based-deployment","title":"Backup and restore for Docker based deployment","text":""},{"location":"administration/backup_recovery/#structure","title":"Structure","text":"

    We assume your seafile volumns path is in /opt/seafile-data. And you want to backup to /backup directory.

    The data files to be backed up:

    /opt/seafile-data/seafile/conf  # configuration files\n/opt/seafile-data/seafile/seafile-data # data of seafile\n/opt/seafile-data/seafile/seahub-data # data of seahub\n
    "},{"location":"administration/backup_recovery/#backing-up-database","title":"Backing up Database","text":"
    # It's recommended to backup the database to a separate file each time. Don't overwrite older database backups for at least a week.\ncd /backup/databases\ndocker exec -it seafile-mysql mariadb-dump  -u[username] -p[password] --opt ccnet_db > ccnet_db.sql\ndocker exec -it seafile-mysql mariadb-dump  -u[username] -p[password] --opt seafile_db > seafile_db.sql\ndocker exec -it seafile-mysql mariadb-dump  -u[username] -p[password] --opt seahub_db > seahub_db.sql\n

    Tip

    The default image of database is Mariadb 10.11 from Seafile 12, you may not be able to find these commands in the container (such as mysqldump: command not found), since commands of mysql* series have been gradually deprecated. So we recommend that you use the mariadb* series of commands.

    However, if you still use the MySQL docker image, you should continue to use mysqldump here:

    docker exec -it seafile-mysql mysqldump  -u[username] -p[password] --opt ccnet_db > ccnet_db.sql\ndocker exec -it seafile-mysql mysqldump  -u[username] -p[password] --opt seafile_db > seafile_db.sql\ndocker exec -it seafile-mysql mysqldump  -u[username] -p[password] --opt seahub_db > seahub_db.sql\n
    "},{"location":"administration/backup_recovery/#backing-up-seafile-library-data_1","title":"Backing up Seafile library data","text":""},{"location":"administration/backup_recovery/#to-directly-copy-the-whole-data-directory","title":"To directly copy the whole data directory","text":"
    cp -R /opt/seafile-data/seafile /backup/data/\n
    "},{"location":"administration/backup_recovery/#use-rsync-to-do-incremental-backup","title":"Use rsync to do incremental backup","text":"
    rsync -az /opt/seafile-data/seafile /backup/data/\n
    "},{"location":"administration/backup_recovery/#recovery","title":"Recovery","text":""},{"location":"administration/backup_recovery/#restore-the-databases_1","title":"Restore the databases","text":"
    docker cp /backup/databases/ccnet_db.sql seafile-mysql:/tmp/ccnet_db.sql\ndocker cp /backup/databases/seafile_db.sql seafile-mysql:/tmp/seafile_db.sql\ndocker cp /backup/databases/seahub_db.sql seafile-mysql:/tmp/seahub_db.sql\n\ndocker exec -it seafile-mysql /bin/sh -c \"mariadb -u[username] -p[password] ccnet_db < /tmp/ccnet_db.sql\"\ndocker exec -it seafile-mysql /bin/sh -c \"mariadb -u[username] -p[password] seafile_db < /tmp/seafile_db.sql\"\ndocker exec -it seafile-mysql /bin/sh -c \"mariadb -u[username] -p[password] seahub_db < /tmp/seahub_db.sql\"\n

    Tip

    The default image of database is Mariadb 10.11 from Seafile 12, you may not be able to find these commands in the container (such as mysql: command not found), since commands of mysql* series have been gradually deprecated. So we recommend that you use the mariadb* series of commands.

    However, if you still use the MySQL docker image, you should continue to use mysql here:

    docker exec -it seafile-mysql /bin/sh -c \"mysql -u[username] -p[password] ccnet_db < /tmp/ccnet_db.sql\"\ndocker exec -it seafile-mysql /bin/sh -c \"mysql -u[username] -p[password] seafile_db < /tmp/seafile_db.sql\"\ndocker exec -it seafile-mysql /bin/sh -c \"mysql -u[username] -p[password] seahub_db < /tmp/seahub_db.sql\"\n
    "},{"location":"administration/backup_recovery/#restore-the-seafile-data","title":"Restore the seafile data","text":"
    cp -R /backup/data/* /opt/seafile-data/seafile/\n
    "},{"location":"administration/clean_database/","title":"Clean Database","text":""},{"location":"administration/clean_database/#session","title":"Session","text":"

    Use the following command to clear expired session records in Seahub database:

    cd seafile-server-latest\n./seahub.sh python-env python3 seahub/manage.py clearsessions\n

    Tip

    Enter into the docker image, then go to /opt/seafile/seafile-server-latest

    "},{"location":"administration/clean_database/#use-clean_db_records-command-to-clean-seahub_db","title":"Use clean_db_records command to clean seahub_db","text":"

    Use the following command to simultaneously clean up table records of Activity, sysadmin_extra_userloginlog, FileAudit, FileUpdate, FileHistory, PermAudit, FileTrash 90 days ago:

    ./seahub.sh python-env python3 seahub/manage.py clean_db_records\n

    You can also clean these tables manually if you like as following.

    "},{"location":"administration/clean_database/#activity","title":"Activity","text":"

    Use the following command to clear the activity records:

    use seahub_db;\nDELETE FROM Activity WHERE to_days(now()) - to_days(timestamp) > 90;\nDELETE FROM UserActivity WHERE to_days(now()) - to_days(timestamp) > 90;\n
    "},{"location":"administration/clean_database/#login","title":"Login","text":"

    Use the following command to clean the login records:

    use seahub_db;\nDELETE FROM sysadmin_extra_userloginlog WHERE to_days(now()) - to_days(login_date) > 90;\n
    "},{"location":"administration/clean_database/#file-access","title":"File Access","text":"

    Use the following command to clean the file access records:

    use seahub_db;\nDELETE FROM FileAudit WHERE to_days(now()) - to_days(timestamp) > 90;\n
    "},{"location":"administration/clean_database/#file-update","title":"File Update","text":"

    Use the following command to clean the file update records:

    use seahub_db;\nDELETE FROM FileUpdate WHERE to_days(now()) - to_days(timestamp) > 90;\n
    "},{"location":"administration/clean_database/#permisson","title":"Permisson","text":"

    Use the following command to clean the permission change audit records:

    use seahub_db;\nDELETE FROM PermAudit WHERE to_days(now()) - to_days(timestamp) > 90;\n
    "},{"location":"administration/clean_database/#file-history","title":"File History","text":"

    Use the following command to clean the file history records:

    use seahub_db;\nDELETE FROM FileHistory WHERE to_days(now()) - to_days(timestamp) > 90;\n
    "},{"location":"administration/clean_database/#clean-outdated-library-data","title":"Clean outdated library data","text":"

    Since version 6.2, we offer command to clear outdated library records in Seafile database, e.g. records that are not deleted after a library is deleted. This is because users can restore a deleted library, so we can't delete these records at library deleting time.

    ./seahub.sh python-env python3 seahub/manage.py clear_invalid_repo_data\n

    This command has been improved in version 10.0, including:

    1. It will clear the invalid data in small batch, avoiding consume too much database resource in a short time.

    2. Dry-run mode: if you just want to see how much invalid data can be deleted without actually deleting any data, you can use the dry-run option, e.g.

    ./seahub.sh python-env python3 seahub/manage.py clear_invalid_repo_data --dry-run=true\n
    "},{"location":"administration/clean_database/#clean-library-sync-tokens","title":"Clean library sync tokens","text":"

    There are two tables in Seafile db that are related to library sync tokens.

    When you have many sync clients connected to the server, these two tables can have large number of rows. Many of them are no longer actively used. You may clean the tokens that are not used in a recent period, by the following SQL query:

    delete t,i from RepoUserToken t, RepoTokenPeerInfo i where t.token=i.token and sync_time < xxxx;\n

    xxxx is the UNIX timestamp for the time before which tokens will be deleted.

    To be safe, you can first check how many tokens will be removed:

    select * from RepoUserToken t, RepoTokenPeerInfo i where t.token=i.token and sync_time < xxxx;\n
    "},{"location":"administration/export_report/","title":"Export Report","text":"

    Since version 7.0.8 pro, Seafile provides commands to export reports via command line.

    Tip

    Enter into the docker image, then go to /opt/seafile/seafile-server-latest

    "},{"location":"administration/export_report/#export-user-traffic-report","title":"Export User Traffic Report","text":"
    cd seafile-server-latest\n./seahub.sh python-env python3 seahub/manage.py export_user_traffic_report --date 201906\n
    "},{"location":"administration/export_report/#export-user-storage-report","title":"Export User Storage Report","text":"
    cd seafile-server-latest\n./seahub.sh python-env python3 seahub/manage.py export_user_storage_report\n
    "},{"location":"administration/export_report/#export-file-access-log","title":"Export File Access Log","text":"
    cd seafile-server-latest\n./seahub.sh python-env python3 seahub/manage.py export_file_access_log --start-date 2019-06-01 --end-date 2019-07-01\n
    "},{"location":"administration/logs/","title":"Seafile server logs","text":""},{"location":"administration/logs/#log-files-of-seafile-server","title":"Log files of seafile server","text":""},{"location":"administration/logs/#log-files-for-seafile-background-node-in-cluster-mode","title":"Log files for seafile background node in cluster mode","text":""},{"location":"administration/seafile_fsck/","title":"Seafile FSCK","text":"

    On the server side, Seafile stores the files in the libraries in an internal format. Seafile has its own representation of directories and files (similar to Git).

    With default installation, these internal objects are stored in the server's file system directly (such as Ext4, NTFS). But most file systems don't assure the integrity of file contents after a hard shutdown or system crash. So if new Seafile internal objects are being written when the system crashes, they can be corrupt after the system reboots. This will make part of the corresponding library not accessible.

    Warning

    If you store the seafile-data directory in a battery-backed NAS (like EMC or NetApp), or use S3 backend available in the Pro edition, the internal objects won't be corrupt.

    Note

    If your Seafile server is deployed with Docker, make sure you have enter the container before executing the following commands in this manual:

    docker exec -it seafile bash\n

    This is also required for the other scripts in this document.

    We provide a seaf-fsck.sh script to check the integrity of libraries. The seaf-fsck tool accepts the following arguments:

    cd /opt/seafile/seafile-server-latest\n./seaf-fsck.sh [--repair|-r] [--export|-E export_path] [repo_id_1 [repo_id_2 ...]]\n

    There are three modes of operation for seaf-fsck:

    1. checking integrity of libraries.
    2. repairing corrupted libraries.
    3. exporting libraries.
    "},{"location":"administration/seafile_fsck/#checking-integrity-of-libraries","title":"Checking Integrity of Libraries","text":"

    Running seaf-fsck.sh without any arguments will run a read-only integrity check for all libraries.

    ./seaf-fsck.sh\n

    If you want to check integrity for specific libraries, just append the library id's as arguments:

    ./seaf-fsck.sh [library-id1] [library-id2] ...\n

    The output looks like:

    [02/13/15 16:21:07] fsck.c(470): Running fsck for repo ca1a860d-e1c1-4a52-8123-0bf9def8697f.\n[02/13/15 16:21:07] fsck.c(413): Checking file system integrity of repo fsck(ca1a860d)...\n[02/13/15 16:21:07] fsck.c(35): Dir 9c09d937397b51e1283d68ee7590cd9ce01fe4c9 is missing.\n[02/13/15 16:21:07] fsck.c(200): Dir /bf/pk/(9c09d937) is corrupted.\n[02/13/15 16:21:07] fsck.c(105): Block 36e3dd8757edeb97758b3b4d8530a4a8a045d3cb is corrupted.\n[02/13/15 16:21:07] fsck.c(178): File /bf/02.1.md(ef37e350) is corrupted.\n[02/13/15 16:21:07] fsck.c(85): Block 650fb22495b0b199cff0f1e1ebf036e548fcb95a is missing.\n[02/13/15 16:21:07] fsck.c(178): File /01.2.md(4a73621f) is corrupted.\n[02/13/15 16:21:07] fsck.c(514): Fsck finished for repo ca1a860d.\n

    The corrupted files and directories are reported in the above message. By the way, you may also see output like the following:

    [02/13/15 16:36:11] Commit 6259251e2b0dd9a8e99925ae6199cbf4c134ec10 is missing\n[02/13/15 16:36:11] fsck.c(476): Repo ca1a860d HEAD commit is corrupted, need to restore to an old version.\n[02/13/15 16:36:11] fsck.c(314): Scanning available commits...\n[02/13/15 16:36:11] fsck.c(376): Find available commit 1b26b13c(created at 2015-02-13 16:10:21) for repo ca1a860d.\n

    This means the head commit (current state of the library) recorded in database is not consistent with the library data. In such case, fsck will try to find the last consistent state and check the integrity in that state.

    Tip

    If you have many libraries, it's helpful to save the fsck output into a log file for later analysis.

    "},{"location":"administration/seafile_fsck/#repairing-corruption","title":"Repairing Corruption","text":"

    Corruption repair in seaf-fsck basically works in two steps:

    1. If the library state (commit) recorded in database is not found in data directory, find the last available state from data directory.
    2. Check data integrity in that specific state. If files or directories are corrupted, set them to empty files or empty directories. The corrupted paths will be reported, so that the user can recover them from somewhere else.

    Running the following command repairs all the libraries:

    ./seaf-fsck.sh --repair\n

    Most of time you run the read-only integrity check first, to find out which libraries are corrupted. And then you repair specific libraries with the following command:

    ./seaf-fsck.sh --repair [library-id1] [library-id2] ...\n

    After repairing, in the library history, seaf-fsck includes the list of files and folders that are corrupted. So it's much easier to located corrupted paths.

    "},{"location":"administration/seafile_fsck/#best-practice-for-repairing-a-library","title":"Best Practice for Repairing a Library","text":"

    To check all libraries and find out which library is corrupted, the system admin can run seaf-fsck.sh without any argument and save the output to a log file. Search for keyword \"Fail\" in the log file to locate corrupted libraries. You can run seaf-fsck to check all libraries when your Seafile server is running. It won't damage or change any files.

    When the system admin find a library is corrupted, he/she should run seaf-fsck.sh with \"--repair\" for the library. After the command fixes the library, the admin should inform user to recover files from other places. There are two ways:

    "},{"location":"administration/seafile_fsck/#speeding-up-fsck-by-not-checking-file-contents","title":"Speeding up FSCK by not checking file contents","text":"

    Starting from Pro edition 7.1.5, an option is added to speed up FSCK. Most of the running time of seaf-fsck is spent on calculating hashes for file contents. This hash will be compared with block object ID. If they're not consistent, the block is detected as corrupted.

    In many cases, the file contents won't be corrupted most of time. Some objects are just missing from the system. So it's enough to only check for object existence. This will greatly speed up the fsck process.

    To skip checking file contents, add the --shallow or -s option to seaf-fsck.

    "},{"location":"administration/seafile_fsck/#exporting-libraries-to-file-system","title":"Exporting Libraries to File System","text":"

    You can use seaf-fsck to export all the files in libraries to external file system (such as Ext4). This procedure doesn't rely on the seafile database. As long as you have your seafile-data directory, you can always export your files from Seafile to external file system. The command about this operation is

    ./seaf-fsck.sh --export top_export_path [library-id1] [library-id2] ...\n

    The argument top_export_path is a directory to place the exported files. Each library will be exported as a sub-directory of the export path. If you don't specify library ids, all libraries will be exported.

    Note

    Currently only un-encrypted libraries can be exported. Encrypted libraries will be skipped.

    "},{"location":"administration/seafile_gc/","title":"Seafile GC","text":"

    Seafile uses storage de-duplication technology to reduce storage usage. The underlying data blocks will not be removed immediately after you delete a file or a library. As a result, the number of unused data blocks will increase on Seafile server.

    To release the storage space occupied by unused blocks, you have to run a \"garbage collection\" program to clean up unused blocks on your server.

    The GC program cleans up two types of unused blocks:

    1. Blocks that no library references to, that is, the blocks belong to deleted libraries;
    2. If you set history length limit on some libraries, the out-dated blocks in those libraries will also be removed.
    "},{"location":"administration/seafile_gc/#run-gc","title":"Run GC","text":"

    Note

    If your Seafile server is deployed with Docker, make sure you have enter the container before executing the script:

    docker exec -it seafile bash\n

    For all scripts in this document, is located in /opt/seafile/seafile-server-latest:

    cd `/opt/seafile/seafile-server-latest # valid both Docker-base Seafile and binary-package-base Seafile\n

    This is also required for the other scripts in this document.

    "},{"location":"administration/seafile_gc/#dry-run-mode","title":"Dry-run Mode","text":"

    To see how much garbage can be collected without actually removing any garbage, use the dry-run option:

    ./seaf-gc.sh --dry-run [repo-id1] [repo-id2] ...\n

    The output should look like:

    [03/19/15 19:41:49] seafserv-gc.c(115): GC version 1 repo My Library(ffa57d93)\n[03/19/15 19:41:49] gc-core.c(394): GC started. Total block number is 265.\n[03/19/15 19:41:49] gc-core.c(75): GC index size is 1024 Byte.\n[03/19/15 19:41:49] gc-core.c(408): Populating index.\n[03/19/15 19:41:49] gc-core.c(262): Populating index for repo ffa57d93.\n[03/19/15 19:41:49] gc-core.c(308): Traversed 5 commits, 265 blocks.\n[03/19/15 19:41:49] gc-core.c(440): Scanning unused blocks.\n[03/19/15 19:41:49] gc-core.c(472): GC finished. 265 blocks total, about 265 reachable blocks, 0 blocks can be removed.\n\n[03/19/15 19:41:49] seafserv-gc.c(115): GC version 1 repo aa(f3d0a8d0)\n[03/19/15 19:41:49] gc-core.c(394): GC started. Total block number is 5.\n[03/19/15 19:41:49] gc-core.c(75): GC index size is 1024 Byte.\n[03/19/15 19:41:49] gc-core.c(408): Populating index.\n[03/19/15 19:41:49] gc-core.c(262): Populating index for repo f3d0a8d0.\n[03/19/15 19:41:49] gc-core.c(308): Traversed 8 commits, 5 blocks.\n[03/19/15 19:41:49] gc-core.c(264): Populating index for sub-repo 9217622a.\n[03/19/15 19:41:49] gc-core.c(308): Traversed 4 commits, 4 blocks.\n[03/19/15 19:41:49] gc-core.c(440): Scanning unused blocks.\n[03/19/15 19:41:49] gc-core.c(472): GC finished. 5 blocks total, about 9 reachable blocks, 0 blocks can be removed.\n\n[03/19/15 19:41:49] seafserv-gc.c(115): GC version 1 repo test2(e7d26d93)\n[03/19/15 19:41:49] gc-core.c(394): GC started. Total block number is 507.\n[03/19/15 19:41:49] gc-core.c(75): GC index size is 1024 Byte.\n[03/19/15 19:41:49] gc-core.c(408): Populating index.\n[03/19/15 19:41:49] gc-core.c(262): Populating index for repo e7d26d93.\n[03/19/15 19:41:49] gc-core.c(308): Traversed 577 commits, 507 blocks.\n[03/19/15 19:41:49] gc-core.c(440): Scanning unused blocks.\n[03/19/15 19:41:49] gc-core.c(472): GC finished. 507 blocks total, about 507 reachable blocks, 0 blocks can be removed.\n\n[03/19/15 19:41:50] seafserv-gc.c(124): === Repos deleted by users ===\n[03/19/15 19:41:50] seafserv-gc.c(145): === GC is finished ===\n\n[03/19/15 19:41:50] Following repos have blocks to be removed:\nrepo-id1\nrepo-id2\nrepo-id3\n

    If you give specific library ids, only those libraries will be checked; otherwise all libraries will be checked.

    repos have blocks to be removed

    Notice that at the end of the output there is a \"repos have blocks to be removed\" section. It contains the list of libraries that have garbage blocks. Later when you run GC without --dry-run option, you can use these libraris ids as input arguments to GC program.

    "},{"location":"administration/seafile_gc/#removing-garbage","title":"Removing Garbage","text":"

    To actually remove garbage blocks, run without the --dry-run option:

    ./seaf-gc.sh [repo-id1] [repo-id2] ...\n

    If libraries ids are specified, only those libraries will be checked for garbage.

    As described before, there are two types of garbage blocks to be removed. Sometimes just removing the first type of blocks (those that belong to deleted libraries) is good enough. In this case, the GC program won't bother to check the libraries for outdated historic blocks. The \"-r\" option implements this feature:

    ./seaf-gc.sh -r\n

    Success

    Libraries deleted by the users are not immediately removed from the system. Instead, they're moved into a \"trash\" in the system admin page. Before they're cleared from the trash, their blocks won't be garbage collected.

    "},{"location":"administration/seafile_gc/#removing-fs-objects","title":"Removing FS objects","text":"

    Since Pro server 8.0.6 and community edition 9.0, you can remove garbage fs objects. It should be run without the --dry-run option:

    ./seaf-gc.sh --rm-fs\n

    Bug reports

    This command has bug before Pro Edition 10.0.15 and Community Edition 11.0.7. It could cause virtual libraries (e.g. shared folders) failing to merge into their parent libraries. Please avoid using this option in the affected versions. Please contact our support team if you are affected by this bug.

    "},{"location":"administration/seafile_gc/#using-multiple-threads-in-gc","title":"Using Multiple Threads in GC","text":"

    You can specify the thread number in GC. By default,

    You can specify the thread number in with \"-t\" option. \"-t\" option can be used together with all other options. Each thread will do GC on one library. For example, the following command will use 20 threads to GC all libraries:

    ./seaf-gc.sh -t 20\n

    Since the threads are concurrent, the output of each thread may mix with each others. Library ID is printed in each line of output.

    "},{"location":"administration/seafile_gc/#run-gc-based-on-library-id-prefix","title":"Run GC based on library ID prefix","text":"

    Since GC usually runs quite slowly as it needs to traverse the entire library history. You can use multiple threads to run GC in parallel. For even larger deployments, it's also desirable to run GC on multiple server in parallel.

    A simple pattern to divide the workload among multiple GC servers is to assign libraries to servers based on library ID. Since Pro edition 7.1.5, this is supported. You can add \"--id-prefix\" option to seaf-gc.sh, to specify the library ID prefix. For example, the below command will only process libraries having \"a123\" as ID prefix.

    ./seaf-gc.sh --id-prefix a123\n
    "},{"location":"administration/security_features/","title":"Security Questions","text":""},{"location":"administration/security_features/#how-is-the-connection-between-client-and-server-encrypted","title":"How is the connection between client and server encrypted?","text":"

    Seafile uses HTTP(S) to syncing files between client and server (Since version 4.1.0).

    "},{"location":"administration/security_features/#encrypted-library","title":"Encrypted Library","text":"

    Seafile provides a feature called encrypted library to protect your privacy. The file encryption/decryption is performed on client-side when using the desktop client for file synchronization. The password of an encrypted library is not stored on the server. Even the system admin of the server can't view the file contents.

    There are a few limitation about this feature:

    1. File metadata is NOT encrypted. The metadata includes: the complete list of directory and file names, every files size, the history of editors, when, and what byte ranges were altered.
    2. The client side encryption does currently NOT work while using the web browser and the cloud file explorer of the desktop client. When you are browsing encrypted libraries via the web browser or the cloud file explorer, you need to input the password and the server is going to use the password to decrypt the \"file key\" for the library (see description below) and cache the password in memory for one hour. The plain text password is never stored or cached on the server.
    3. If you create an encrypted library on the web interface, the library password and encryption keys will pass through the server. If you want end-to-end protection, you should create encrypted libraries from desktop client only.
    4. For encryption protocol version 4, each library use its own salt to derive key/iv pairs. However, all files within a library shares the same salt. Likewise, all the files within a library are encrypted with the same key/iv pair. With encryption protocol version 2, all libraries use the same salt, but separate key/iv pairs.
    5. Encrypted library doesn't ensure file integrity. For example, the server admin can still partially change the contents of files in an encrypted library. The client is not able to detect such changes to contents.

    The client side encryption works on iOS client since version 2.1.6. The Android client support client side encryption since version 2.1.0. But since version 3.0.0, the iOS and Android clients drop support for client side encryptioin. You need to send the password to the server to encrypt/decrypt files.

    "},{"location":"administration/security_features/#how-does-an-encrypted-library-work","title":"How does an encrypted library work?","text":"

    When you create an encrypted library, you'll need to provide a password for it. All the data in that library will be encrypted with the password before uploading it to the server (see limitations above).

    "},{"location":"administration/security_features/#encryptiondecryption-procedure","title":"Encryption/Decryption procedure","text":"

    There are currently two supported encryption protocol versions for encrypted libraries, version 2 and versioin 4. The two versions shares the same basic procedure so we first describe the procedure.

    1. Generate a 32-byte long cryptographically strong random number. This will be used as the file encryption key (\"file key\").
    2. Encrypt the file key with the user provided password. We first use a secure hash algorithm to derive a key/iv pair from the password, then use AES 256/CBC to encrypt the file key. The result is called the \"encrypted file key\". This encrypted file key will be sent to and stored on the server. When you need to access the data, you can decrypt the file key from the encrypted file key.
    3. A \"magic token\" is derived from the password and library id, with the same secure hash algorithm. This token is stored with the library and will be use to check passwords before decrypting data later.
    4. All file data is encrypted by the file key with AES 256/CBC. We use PBKDF2-SHA256 with 1000 iterations to derive key/iv pair from the file key. After encryption, the data is uploaded to the server.

    The only difference between version 2 and version 4 is on the usage of salt for the secure hash algorithm. In version 2, all libaries share the same fixed salt. In version 4, each library will use a separate and randomly generated salt.

    "},{"location":"administration/security_features/#secure-hash-algorithms-for-password-verification","title":"Secure hash algorithms for password verification","text":"

    A secure hash algorithm is used to derive key/iv pair for encrypting the file key. So it's critical to choose a relatively costly algorithm to prevent brute-force guessing for the password.

    Before version 12, a fixed secure hash algorithm (PBKDF2-SHA256 with 1000 iterations) is used, which is far from secure for today's standard.

    Since Seafile server version 12, we allow the admin to choose proper secure hash algorithms. Currently two hash algorithms are supported.

    "},{"location":"administration/security_features/#client-side-encryption-and-decryption","title":"Client-side encryption and decryption","text":"

    The above encryption procedure can be executed on the desktop and the mobile client. The Seahub browser client uses a different encryption procedure that happens at the server. Because of this your password will be transferred to the server.

    When you sync an encrypted library to the desktop, the client needs to verify your password. When you create the library, a \"magic token\" is derived from the password and library id. This token is stored with the library on the server side. The client use this token to check whether your password is correct before you sync the library. The magic token is generated by the secure hash algorithm chosen when the library was created.

    For maximum security, the plain-text password won't be saved on the client side, too. The client only saves the key/iv pair derived from the \"file key\", which is used to decrypt the data. So if you forget the password, you won't be able to recover it or access your data on the server.

    "},{"location":"administration/security_features/#why-fileserver-delivers-every-content-to-everybody-knowing-the-content-url-of-an-unshared-private-file","title":"Why fileserver delivers every content to everybody knowing the content URL of an unshared private file?","text":"

    When a file download link is clicked, a random URL is generated for user to access the file from fileserver. This url can only be access once. After that, all access will be denied to the url. So even if someone else happens to know about the url, he can't access it anymore.

    This was changed in Seafile server version 12. Instead of a random URL, a URL like 'https://yourserver.com/seafhttp/repos/{library id}/file_path' is used for downloading the file. Authorization will be done by checking cookies or API tokens on the server side. This makes the URL more cache-friendly while still being secure.

    "},{"location":"administration/security_features/#how-does-seafile-store-user-login-password","title":"How does Seafile store user login password?","text":"

    User login passwords are stored in hash form only. Note that user login password is different from the passwords used in encrypted libraries. In the database, its format is

    PBKDF2SHA256$iterations$salt$hash\n

    The record is divided into 4 parts by the $ sign.

    To calculate the hash:

    "},{"location":"administration/two_factor_authentication/","title":"Two-Factor Authentication","text":"

    Starting from version 6.0, we added Two-Factor Authentication to enhance account security.

    There are two ways to enable this feature:

    After that, there will be a \"Two-Factor Authentication\" section in the user profile page.

    Users can use the Google Authenticator app on their smart-phone to scan the QR code.

    "},{"location":"changelog/changelog-for-seafile-professional-server-old/","title":"Seafile Professional Server Changelog (old)","text":""},{"location":"changelog/changelog-for-seafile-professional-server-old/#44","title":"4.4","text":"

    Note: Two new options are added in version 4.4, both are in seahub_settings.py

    This version contains no database table change.

    "},{"location":"changelog/changelog-for-seafile-professional-server-old/#449-20160229","title":"4.4.9 (2016.02.29)","text":""},{"location":"changelog/changelog-for-seafile-professional-server-old/#448-20151217","title":"4.4.8 (2015.12.17)","text":""},{"location":"changelog/changelog-for-seafile-professional-server-old/#447-20151120","title":"4.4.7 (2015.11.20)","text":""},{"location":"changelog/changelog-for-seafile-professional-server-old/#446-20151109","title":"4.4.6 (2015.11.09)","text":"