-
Notifications
You must be signed in to change notification settings - Fork 50
/
Copy pathmkdocs.yml
213 lines (203 loc) · 8.42 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
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
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
- Seafile Components: introduction/components.md
- File permission management: introduction/file_permission_management.md
- Roadmap: introduction/roadmap.md
- Contribution: introduction/contribution.md
- Setup:
- Overview: setup/overview.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):
- Seafile Docker Cluster Deployment: setup/cluster_deploy_with_docker.md
- Setup with Kubernetes (K8s): setup/cluster_deploy_with_k8s.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):
- Seafile Community Setup:
- Outline: setup_binary/outline_ce.md
- Installation: setup_binary/installation_ce.md
- HTTPS with Nginx: setup_binary/https_with_nginx.md
- Seafile Professional Setup:
- Outline: setup_binary/outline_pro.md
- License: setup_binary/seafile_professional_sdition_software_license_agreement.md
- Installation: setup_binary/installation_pro.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
- Migrate From SQLite to MySQL: setup_binary/migrate_from_sqlite_to_mysql.md
- Extensions:
- Extra Seafile components:
- SeaDoc Integration: extension/setup_seadoc.md
- Notification Server: extension/notification-server.md
- WebDAV extension: extension/webdav.md
- FUSE extension: extension/fuse.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_11.0_ce.md
- LDAP Integration (Pro): config/ldap_in_11.0_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_in_10.0.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
- ccnet.conf: config/ccnet-conf.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
- 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
- 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 7.1.x: upgrade/upgrade_notes_for_7.1.x.md
- Upgrade notes for 8.0.x: upgrade/upgrade_notes_for_8.0.x.md
- Upgrade notes for 9.0.x: upgrade/upgrade_notes_for_9.0.x.md
- Upgrade notes for 10.0.x: upgrade/upgrade_notes_for_10.0.x.md
- Upgrade notes for 11.0.x: upgrade/upgrade_notes_for_11.0.x.md
- Upgrade notes for 12.0.x: upgrade/upgrade_notes_for_12.0.x.md
- Developing:
- Outline: develop/README.md
- How to Build Seafile:
- Outline: develop/build_seafile.md
- Linux: develop/linux.md
- macOS: develop/osx.md
- Windows: develop/windows.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