From e5efeee9ab4892456a658e9a4a845c49ceb12901 Mon Sep 17 00:00:00 2001 From: Junxiang Huang Date: Mon, 25 Nov 2024 13:29:34 +0800 Subject: [PATCH] opt: 12.0 some sentences --- manual/extension/fuse.md | 2 +- manual/extension/libreoffice_online.md | 4 +- manual/introduction/components.md | 2 +- manual/setup/caddy.md | 2 +- manual/setup/setup_ce_by_docker.md | 72 +++++++++++++++++++++++++- manual/setup/setup_pro_by_docker.md | 72 +++++++++++++++++++++++++- mkdocs.yml | 4 +- 7 files changed, 149 insertions(+), 9 deletions(-) diff --git a/manual/extension/fuse.md b/manual/extension/fuse.md index 2019c8b33..082a6bade 100644 --- a/manual/extension/fuse.md +++ b/manual/extension/fuse.md @@ -10,7 +10,7 @@ However, administrators sometimes want to access the files directly on the serve * Encrypted folders can't be accessed by seaf-fuse. * 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. + * On debian/centos systems, you need to be in the "fuse" group to have the permission to mount a FUSE folder. ## Use seaf-fuse in Docker based deployment diff --git a/manual/extension/libreoffice_online.md b/manual/extension/libreoffice_online.md index 018dcd90c..9e1526832 100644 --- a/manual/extension/libreoffice_online.md +++ b/manual/extension/libreoffice_online.md @@ -6,9 +6,9 @@ Since Seafile Professional edition 6.0.0, you can integrate Seafile with Collabo !!! tip "Deployment Tips" - From Seafile 12.0, Seafile support integrating CollaboraOnline server on the same host (only support deploying with [Docker](../setup/setup_pro_by_docker.md) with sufficient cores and RAM), as you can follow the steps in this manual. + The steps from this guide only cover installing collabora as another container on the same docker host that your seafile docker container is on. **Please make sure your host have sufficient cores and RAM**. - Otherwise, you can follow the [official document](https://sdk.collaboraonline.com/docs/installation/CODE_Docker_image.html#code-docker-image) to deploy CollaboraOnline server on a separate host. Then you should follow [here](#Libreoffice-server-on-a-separate-host) to configure `seahub_settings.py` to enable online office. + If you want to install on another host please refer the collabora documentation for [instructions](https://sdk.collaboraonline.com/docs/installation/CODE_Docker_image.html#code-docker-image). Then you should follow [here](#Libreoffice-server-on-a-separate-host) to configure `seahub_settings.py` to enable online office. !!! note To integrate *LibreOffice* with Seafile, you have to enable **HTTPS** in your Seafile server: diff --git a/manual/introduction/components.md b/manual/introduction/components.md index 8d47677d7..9820f3e07 100644 --- a/manual/introduction/components.md +++ b/manual/introduction/components.md @@ -2,7 +2,7 @@ Seafile Server consists of the following two components: -- **Seahub** (django)：the web frontend. Seafile server package contains a light-weight Python HTTP server gunicorn that serves the website. By default, Seahub runs as an application within gunicorn. You can also configure Seahub to run under WSGI mode behind Nginx or Apache. This is recommended for production setups. +- **Seahub** (django)：the web frontend. Seafile server package contains a light-weight Python HTTP server gunicorn that serves the website. By default, Seahub runs as an application within gunicorn. - **Seafile server** (``seaf-server``)：data service daemon, handles raw file upload, download and synchronization. Seafile server by default listens on port 8082. You can configure Nginx/Apache to proxy traffic to the local 8082 port. The picture below shows how Seafile clients access files when you configure Seafile behind Nginx/Apache. diff --git a/manual/setup/caddy.md b/manual/setup/caddy.md index c262fd5d0..7374486b0 100644 --- a/manual/setup/caddy.md +++ b/manual/setup/caddy.md @@ -3,7 +3,7 @@ !!! note From Seafile Docker 12.0, HTTPS will be handled by the [***Caddy***](https://caddyserver.com/docs/). The default caddy image used of Seafile docker is [`lucaslorentz/caddy-docker-proxy:2.9`](https://github.com/lucaslorentz/caddy-docker-proxy). -Caddy is a modern open source web server that mainly binds external traffic and internal services in [seafile docker](./overview.md). In addition to the advantages of traditional proxy components (e.g., *nginx*), Caddy also makes it easier for users to complete the acquisite and update of HTTPS certificates by providing simpler configurations. +Caddy is a modern open source web server that mainly binds external traffic and internal services in [seafile docker](./overview.md). In addition to the advantages of traditional proxy components (e.g., *nginx*), Caddy also makes it easier for users to complete the acquisition and update of HTTPS certificates by providing simpler configurations. To engage HTTPS, users only needs to correctly configure the following fields in `.env`: diff --git a/manual/setup/setup_ce_by_docker.md b/manual/setup/setup_ce_by_docker.md index 42158a221..599f7a4a1 100644 --- a/manual/setup/setup_ce_by_docker.md +++ b/manual/setup/setup_ce_by_docker.md @@ -67,7 +67,77 @@ docker compose up -d docker compose -f /path/to/.env up -d ``` -Wait for a few minutes for the first time initialization, then visit `http://seafile.example.com` to open Seafile Web UI. +!!! success + After starting the services, you can see the initialization progress by tracing the logs of container `seafile` (i.e., `docker logs seafile -f`) + + ``` + --------------------------------- + This is your configuration + --------------------------------- + + server name: seafile + server ip/domain: seafile.example.com + + seafile data dir: /opt/seafile/seafile-data + fileserver port: 8082 + + database: create new + ccnet database: ccnet_db + seafile database: seafile_db + seahub database: seahub_db + database user: seafile + + + Generating seafile configuration ... + + done + Generating seahub configuration ... + + ---------------------------------------- + Now creating seafevents database tables ... + + ---------------------------------------- + ---------------------------------------- + Now creating ccnet database tables ... + + ---------------------------------------- + ---------------------------------------- + Now creating seafile database tables ... + + ---------------------------------------- + ---------------------------------------- + Now creating seahub database tables ... + + ---------------------------------------- + + creating seafile-server-latest symbolic link ... done + + ----------------------------------------------------------------- + Your seafile server configuration has been finished successfully. + ----------------------------------------------------------------- + + ``` + + And then you can see the following messages which the Seafile server starts successfully: + + ``` + Starting seafile server, please wait ... + Seafile server started + + Done. + + Starting seahub at port 8000 ... + + ---------------------------------------- + Successfully created seafile admin + ---------------------------------------- + + Seahub is started + + Done. + ``` + + Finially, you can go to `http://seafile.example.com` to use Seafile. ## Seafile directory structure diff --git a/manual/setup/setup_pro_by_docker.md b/manual/setup/setup_pro_by_docker.md index 1a12ff2e2..8af524c3a 100644 --- a/manual/setup/setup_pro_by_docker.md +++ b/manual/setup/setup_pro_by_docker.md @@ -119,7 +119,77 @@ docker compose up -d docker compose -f /path/to/.env up -d ``` -Wait a few moment for the database to initialize. You can now access Seafile at the host name specified in the Compose file. +!!! success + After starting the services, you can see the initialization progress by tracing the logs of container `seafile` (i.e., `docker logs seafile -f`) + + ``` + --------------------------------- + This is your configuration + --------------------------------- + + server name: seafile + server ip/domain: seafile.example.com + + seafile data dir: /opt/seafile/seafile-data + fileserver port: 8082 + + database: create new + ccnet database: ccnet_db + seafile database: seafile_db + seahub database: seahub_db + database user: seafile + + + Generating seafile configuration ... + + done + Generating seahub configuration ... + + ---------------------------------------- + Now creating seafevents database tables ... + + ---------------------------------------- + ---------------------------------------- + Now creating ccnet database tables ... + + ---------------------------------------- + ---------------------------------------- + Now creating seafile database tables ... + + ---------------------------------------- + ---------------------------------------- + Now creating seahub database tables ... + + ---------------------------------------- + + creating seafile-server-latest symbolic link ... done + + ----------------------------------------------------------------- + Your seafile server configuration has been finished successfully. + ----------------------------------------------------------------- + + ``` + + And then you can see the following messages which the Seafile server starts successfully: + + ``` + Starting seafile server, please wait ... + Seafile server started + + Done. + + Starting seahub at port 8000 ... + + ---------------------------------------- + Successfully created seafile admin + ---------------------------------------- + + Seahub is started + + Done. + ``` + + Finially, you can go to `http://seafile.example.com` to use Seafile. !!! tip "A 502 Bad Gateway error means that the system has not yet completed the initialization" diff --git a/mkdocs.yml b/mkdocs.yml index 88e920834..b313e2b7a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -97,7 +97,7 @@ nav: - Seafile Docker autostart: setup/seafile_docker_autostart.md - Deploy with an existing MySQL server: setup/setup_with_an_existing_mysql_server.md - Run Seafile as non root user inside docker: setup/run_seafile_as_non_root_user_inside_docker.md - - Cluster installation: + - Cluster installation (Pro): - Seafile Docker Cluster Deployment: setup/cluster_deploy_with_docker.md - Setup with Kubernetes (K8s): setup/cluster_deploy_with_k8s.md - Migration: @@ -133,7 +133,7 @@ nav: - Collabora Online Integration: extension/libreoffice_online.md - OnlyOffice Integration: extension/only_office.md - Office Online Server Integration (Pro): extension/office_web_app.md - - Cluster: + - Cluster (Pro): - Distributed indexing: extension/distributed_indexing.md - Virus Scan (Pro): - Outline: extension/virus_scan.md