site_name: Seafile Admin Manual site_author: seafile docs_dir: ./manual site_url: https://haiwen.github.io/seafile-admin-docs/ repo_name: haiwen/seafile-admin-docs repo_url: https://github.com/haiwen/seafile-admin-docs/ edit_uri: blob/master/manual copyright: Copyright © 2024 Seafile Ltd. theme: name: material logo: media/seafile-transparent-1024.png favicon: media/favicon.ico features: - navigation.footer - navigation.tracking - navigation.sections - navigation.tabs - navigation.top - search.suggest - search.highlight - search.share - math - content.code.copy - content.code.annotate palette: - scheme: default primary: indigo accent: indigo toggle: icon: material/brightness-7 name: Switch to dark mode - scheme: slate toggle: icon: material/brightness-4 name: Switch to light mode plugins: - search - awesome-pages - mike # Customization extra: social: - icon: fontawesome/brands/github link: https://github.com/haiwen/seafile-admin-docs/ version: provider: mike status: new: Work in progress extra_css: - stylesheets/extra.css extra_javascript: - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML # Extensions markdown_extensions: - markdown.extensions.admonition - markdown.extensions.attr_list - markdown.extensions.codehilite: guess_lang: true - markdown.extensions.def_list - markdown.extensions.footnotes - markdown.extensions.meta - markdown.extensions.toc: permalink: true toc_depth: "1-4" - pymdownx.superfences: # allows 1) nesting of fences 2) custom fences 3) disable indented code custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: # provides a syntax to easily add tabbed Markdown content alternate_style: true - pymdownx.arithmatex: # LaTex format support generic: true # Page tree nav: - Introduction: - Introduction: README.md - File permission management: introduction/file_permission_management.md - Seafile Pro edition license: introduction/seafile_professional_sdition_software_license_agreement.md - Roadmap: introduction/roadmap.md - Contribution: introduction/contribution.md - Setup: - Overview: setup/overview.md - System requirements: setup/system_requirements.md - Supported architecture: setup/architecture.md - HTTPS and Caddy: setup/caddy.md - Single node installation: - Setup community edition: setup/setup_ce_by_docker.md - Setup pro edition: setup/setup_pro_by_docker.md - Advanced topics: - Storage Backends: - S3 Backend: setup/setup_with_s3.md - Ceph Backend: setup/setup_with_ceph.md - OpenStack Swift Backend: setup/setup_with_swift.md - Multiple Storage Backends: setup/setup_with_multiple_storage_backends.md - Data migration: setup/migrate_backends_data.md - Use SeaSearch as search engine (Pro): setup/use_seasearch.md - Seafile Docker autostart: setup/seafile_docker_autostart.md - Deploy with an existing MySQL server: setup/setup_with_an_existing_mysql_server.md - Use other reverse proxy: setup/use_other_reverse_proxy.md - Run Seafile as non root user inside docker: setup/run_seafile_as_non_root_user_inside_docker.md - Cluster installation (Pro): setup/cluster_deploy_with_docker.md - Setup with Kubernetes (K8S): - With Helm: - Single node: setup/helm_chart_single_node.md - Cluster (Pro): setup/helm_chart_cluster.md - By K8S resource files: - Single node: setup/k8s_single_node.md - Cluster (Pro): setup/cluster_deploy_with_k8s.md - Seafile K8S advanced management: setup/k8s_advanced_management.md - Migration: - Migration from Seafile Community: setup/migrate_ce_to_pro_with_docker.md - Migrate from non-docker deployment: setup/migrate_non_docker_to_docker.md - Setup (binary): - Outline: setup_binary/outline.md - Installation: setup_binary/installation.md - HTTPS with Nginx: setup_binary/https_with_nginx.md - Cluster Deployment: setup_binary/cluster_deployment.md - Other deployment notes: - Start Seafile at System Bootup: setup_binary/start_seafile_at_system_bootup.md - Logrotate: setup_binary/using_logrotate.md - Extensions: - Extra Seafile components: - SeaDoc Integration: extension/setup_seadoc.md - Notification Server: extension/notification-server.md - Metadata Server: extension/metadata-server.md - Thumbnail Server: extension/thumbnail-server.md - WebDAV extension: extension/webdav.md - FUSE extension: extension/fuse.md - Seafile AI extension: extension/seafile-ai.md - Online Office: - Collabora Online Integration: extension/libreoffice_online.md - OnlyOffice Integration: extension/only_office.md - Office Online Server Integration (Pro): extension/office_web_app.md - Cluster (Pro): - Distributed indexing: extension/distributed_indexing.md - Virus Scan (Pro): - Outline: extension/virus_scan.md - Virus scan with ClamAV: extension/virus_scan_with_clamav.md - Virus scan with Kav4fs: extension/virus_scan_with_kav4fs.md - Configuration: - Authentication & Users: - LDAP/AD Integration: - LDAP Integration: config/ldap_in_ce.md - LDAP Integration (Pro): config/ldap_in_pro.md - Single Sign On: - Outline: config/single_sign_on.md - OAuth Authentication: config/oauth.md - Remote User Authentication: config/remote_user.md - Shibboleth Authentication: config/shibboleth_authentication.md - Auto Login to SeaDrive on Windows: config/auto_login_seadrive.md - SAML 2.0 (Pro): config/saml2.md - Switch authentication: config/auth_switch.md - Advanced User Management (Pro): - Multi-Institutions Support: config/multi_institutions.md - Roles and Permissions: config/roles_permissions.md - Administrator Roles and Permissions: config/admin_roles_permissions.md - Multi-Tenancy Support: config/multi_tenancy.md - Advanced File Search configuration (Pro): config/details_about_file_search.md - Open Cloud Mesh: config/ocm.md - Available configuration options: - Outline: config/README.md - Environment variables: config/env.md - seafile.conf: config/seafile-conf.md - seahub_settings.py: config/seahub_settings_py.md - seafevents.conf: config/seafevents-conf.md - Seahub customization: config/seahub_customization.md - Email Sending: config/sending_email.md - Administration: - Outline: administration/README.md - Account management: administration/account.md - Two-factor Authentication: administration/two_factor_authentication.md - Security features: administration/security_features.md - Access logs and auditing: administration/auditing.md - Export report: administration/export_report.md - Seafile server logs: administration/logs.md - Backup and Recovery: administration/backup_recovery.md - Seafile FSCK: administration/seafile_fsck.md - Seafile GC: administration/seafile_gc.md - Clean database: administration/clean_database.md - Monitor Seafile with Prometheus: administration/seafile_metrics.md - Upgrade: - Outline: upgrade/upgrade.md - Upgrade Seafile Docker: upgrade/upgrade_docker.md - Upgrade Seafile Cluster: upgrade/upgrade_a_cluster.md - Upgrade Seafile Cluster (binary): upgrade/upgrade_a_cluster_binary.md - Upgrade notes for 13.0.x: upgrade/upgrade_notes_for_13.0.x.md - Upgrade notes for 12.0.x: upgrade/upgrade_notes_for_12.0.x.md - Upgrade notes for 11.0.x: upgrade/upgrade_notes_for_11.0.x.md - Upgrade notes for 10.0.x: upgrade/upgrade_notes_for_10.0.x.md - Upgrade notes for 9.0.x: upgrade/upgrade_notes_for_9.0.x.md - Summary of obsolete configurations: upgrade/seafile_obsolete_configurations.md - Developing: - Outline: develop/README.md - Seafile client: - Linux: develop/linux.md - macOS: develop/osx.md - Windows: develop/windows.md - How to Build Seafile: - Outline: develop/build_seafile.md - Server development: develop/server.md - Server binary package: develop/rpi.md - Translation: develop/translation.md - Web API V2.1: develop/web_api_v2.1.md - PHP API: https://github.com/rene-s/Seafile-PHP-SDK - Data Model: develop/data_model.md - ChangeLog: - Seafile Community Edition: changelog/server-changelog.md - Seafile Professional Edition: changelog/changelog-for-seafile-professional-server.md - Seafile Client: changelog/client-changelog.md - Drive Client: changelog/drive-client-changelog.md