diff --git a/manual/extension/setup_seadoc.md b/manual/extension/setup_seadoc.md index b2cf831a..d34459e9 100644 --- a/manual/extension/setup_seadoc.md +++ b/manual/extension/setup_seadoc.md @@ -40,7 +40,7 @@ SeaDoc has the following deployment methods: ## SeaDoc and Seafile docker are deployed on the same host -### Download the seadoc.yml and integrate SeaDoc in Seafile docker +Download the `seadoc.yml` and integrate SeaDoc in Seafile docker. ```shell # for community edition @@ -69,7 +69,7 @@ Now you can use SeaDoc! ## Deploy SeaDoc on a new host -### Download and modify seadoc.yml +Download and modify the `.env` and `seadoc.yml` files. Download [seadoc.yml](../docker/seadoc/1.0/standalone/seadoc.yml) and [.env](../docker/seadoc/1.0/standalone/env) sample files to your host. Then modify the `.env` file according to your environment. The following fields are needed to be modified: @@ -95,7 +95,7 @@ Now you can use SeaDoc! ## SeaDoc directory structure -### `/opt/seadoc-data` +`/opt/seadoc-data` Placeholder spot for shared volumes. You may elect to store certain persistent information outside of a container, in our case we keep various log files outside. This allows you to rebuild containers easily without losing important information. diff --git a/manual/upgrade/upgrade_docker.md b/manual/upgrade/upgrade_docker.md index aff201fd..37763720 100644 --- a/manual/upgrade/upgrade_docker.md +++ b/manual/upgrade/upgrade_docker.md @@ -123,7 +123,8 @@ The following fields merit particular attention: - `SEAFILE_MYSQL_VOLUME`: The volume directory of MySQL data, default is `/opt/seafile-mysql/db` - `SEAFILE_CADDY_VOLUME`: The volume directory of Caddy data used to store certificates obtained from Let's Encrypt's, default is `/opt/seafile-caddy` - `SEAFILE_ELASTICSEARCH_VOLUME`: The volume directory of Elasticsearch data -- `INIT_SEAFILE_MYSQL_ROOT_PASSWORD`: The `root` password of MySQL +- `SEAFILE_MYSQL_DB_HOST`: The host of MySQL +- `SEAFILE_MYSQL_DB_USER`: The user of MySQL, default is `seafile` - `SEAFILE_MYSQL_DB_PASSWORD`: The user `seafile` password of MySQL - `JWT`: JWT_PRIVATE_KEY, A random string with a length of no less than 32 characters, generate example: `pwgen -s 40 1` - `SEAFILE_SERVER_HOSTNAME`: Seafile server hostname or domain @@ -176,40 +177,19 @@ Start with docker compose up. ### Upgrade SeaDoc from 0.8 to 1.0 for Seafile v12.0 -If you have deployed SeaDoc extension in version 11.0, please use the following steps to upgrade it to version 1.0. +If you have deployed SeaDoc v0.8 with Seafile v11.0, you can upgrade it to 1.0 use the following two steps: -SeaDoc 1.0 is for working with Seafile 12.0. SeaDoc and Seafile are deployed in the same directory. SeaDoc has no state in itself. You can simplify delete old configuration file and directory of v0.8. Then deploy SeaDoc 1.0 as following. +1. Delete sdoc_db. +2. Remove SeaDoc configs in seafile.nginx.conf file. +3. Re-deploy SeaDoc server. In other words, delete the old SeaDoc deployment and deploy a new SeaDoc server on a separate machine. -In version 1.0, we use .env file to configure SeaDoc docker image, instead of modifying the docker-compose.yml file directly. +Note, deploying SeaDoc and **Seafile binary package** on the same server is no longer supported. If you really want to deploying SeaDoc and Seafile server on the same machine, you should deploy Seafile server with Docker. -Download [seadoc.yml](../docker/ce/seadoc.yml) to the Seafile `seafile-server.yml` directory, then modify Seafile .env file. +#### Delete sdoc_db -For community edition: +From version 1.0, SeaDoc is using seahub_db database to store its operation logs and no longer need an extra database sdoc_db. The database tables in seahub_db are created automatically when you upgrade Seafile server from v11.0 to v12.0. You can simply delete sdoc_db. -```sh -wget https://manual.seafile.com/12.0/docker/ce/seadoc.yml -``` - -For pro edition: - -```sh -wget https://manual.seafile.com/12.0/docker/pro/seadoc.yml -``` - -```env -COMPOSE_FILE='seafile-server.yml,caddy.yml,seadoc.yml' - -SEADOC_VOLUME=/opt/seadoc-data -ENABLE_SEADOC=true -SEADOC_SERVER_URL=http://example.seafile.com/sdoc-server -``` - -The following fields merit particular attention: - -* Add `seadoc.yml` to the `COMPOSE_FILE` field. -* The volume directory of SeaDoc data (SEADOC_VOLUME) -* Enable SeaDoc (ENABLE_SEADOC) -* SeaDoc service url (SEADOC_SERVER_URL, hostname + `/sdoc-server`) +#### Remove SeaDoc configs in seafile.nginx.conf file If you have deployed SeaDoc older version, you should remove `/sdoc-server/`, `/socket.io` configs in seafile.nginx.conf file. @@ -248,10 +228,6 @@ If you have deployed SeaDoc older version, you should remove `/sdoc-server/`, `/ # } ``` -Start Seafile server and SeaDoc server with the following command +#### Deploy a new SeaDoc server -```sh -docker compose down - -docker compose up -d -``` +Please see the document [Setup SeaDoc](../extension/setup_seadoc.md) to install SeaDoc on a separate machine and integrate with your binary packaged based Seafile server v12.0.