4.5 KiB
SeaDoc Integration
SeaDoc is an extension of Seafile that providing an online collaborative document editor.
SeaDoc designed around the following key ideas:
- An expressive easy to use editor
- A review and approval workflow to better control how contents changes
- Inter-document linking for connecting related contents
- AI integration that streamlines content generation, summarization, and management
- Comprehensive APIs for automating document generating and processing
SeaDoc excels at:
- Authoring product and technical documents
- Creating knowledge base articles and online manuals
- Building internal Wikis
Architecture
The SeaDoc archticture is demonstrated as below:
Here is the workflow when a user open sdoc file in browser
- When a user open a sdoc file in the browser, a file loading request will be sent to Caddy, and Caddy proxy the request to SeaDoc server (see Seafile instance archticture for the details).
- SeaDoc server will send the file's content back if it is already cached, otherwise SeaDoc serve will sends a request to Seafile server.
- Seafile server loads the content, then sends it to SeaDoc server and write it to the cache at the same time.
- After SeaDoc receives the content, it will be sent to the browser.
Deployment method
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.
```shell
wget https://manual.seafile.com/12.0/docker/seadoc.yml
```
Modify `.env`, and insert `seadoc.yml` into `COMPOSE_FILE`, and enable SeaDoc server
```shell
COMPOSE_FILE='seafile-server.yml,caddy.yml,seadoc.yml'
ENABLE_SEADOC=true
SEADOC_SERVER_URL=https://example.seafile.com/sdoc-server
```
=== "Deploy SeaDoc on a new host"
Download and modify the `.env` and `seadoc.yml` files.
```sh
wget https://manual.seafile.com/12.0/docker/seadoc/1.0/standalone/seadoc.yml
wget -o .env https://manual.seafile.com/12.0/docker/seadoc/1.0/standalone/env.yml
```
Then modify the `.env` file according to your environment. The following fields are needed to be modified:
| variable | description |
|------------------------|---------------------------------------------------------------------------------------------------------------|
| `SEADOC_VOLUME` | The volume directory of SeaDoc data |
| `SEAFILE_MYSQL_DB_HOST`| Seafile MySQL host |
| `SEAFILE_MYSQL_DB_USER`| Seafile MySQL user, default is `seafile` |
| `SEAFILE_MYSQL_DB_PASSWORD`| Seafile MySQL password |
| `TIME_ZONE` | Time zone |
| `JWT_PRIVATE_KEY` | JWT key, the same as the config in Seafile `.env` file |
| `SEAFILE_SERVER_HOSTNAME`| Seafile host name |
| `SEAFILE_SERVER_PROTOCOL`| http or https |
| `SEADOC_SERVER_URL` | SeaDoc service URL |
!!! note
Please bind SeaDoc server url and ip in the load balance(or reverse proxy) configuration after starting SeaDoc server
Start SeaDoc server with the following command
docker compose up -d
Now you can use SeaDoc!
SeaDoc directory structure
/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.
- /opt/seadoc-data/logs: This is the directory for SeaDoc logs.
Database used by SeaDoc
SeaDoc used one database table seahub_db.sdoc_operation_log to store operation logs.