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:

SeaDoc

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 SeaDoc¶

The easiest way to deployment SeaDoc is to deploy it with Seafile server on the same host using the same Docker network. If in some situations, you need to deployment SeaDoc standalone, you can follow the next section.

Download the seadoc.yml to /opt/seafile

wget https://manual.seafile.com/12.0/docker/seadoc.yml

Modify .env, and insert seadoc.yml into COMPOSE_FILE, and enable SeaDoc server

COMPOSE_FILE='seafile-server.yml,caddy.yml,seadoc.yml'

ENABLE_SEADOC=true
SEADOC_SERVER_URL=https://seafile.example.com/sdoc-server

Start SeaDoc server server with the following command
```
docker compose up -d
```

Now you can use SeaDoc!

Deploy SeaDoc standalone¶

If you deploy Seafile in a cluster or if you deploy Seafile with binary package, you need to setup SeaDoc as a standalone service. Here are the steps:

Download and modify the .env and seadoc.yml files to directory /opt/seadoc

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

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

(Optional) By default, SeaDoc server will bind to port 80 on the host machine. If the port is already taken by another service, you have to change the listening port of SeaDoc:

Modify seadoc.yml
```
services:
    seadoc:
    ...
    ports:
        - "<your SeaDoc server port>:80"
...
```

Add a reverse proxy for SeaDoc server. In cluster environtment, it means you need to add reverse proxy rules at load balance. Here, we use Nginx as an example (please replace 127.0.0.1:80 to host:port of your Seadoc server)

...
server {
    ...

    location /sdoc-server/ {
        proxy_pass         http://127.0.0.1:80/;
        proxy_redirect     off;
        proxy_set_header   Host              $host;
        proxy_set_header   X-Real-IP         $remote_addr;
        proxy_set_header   X-Forwarded-For   $proxy_add_x_forwarded_for;
        proxy_set_header   X-Forwarded-Host  $server_name;
        proxy_set_header   X-Forwarded-Proto $scheme;

        client_max_body_size 100m;
    }

    location /socket.io {
        proxy_pass http://127.0.0.1:80;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_redirect off;

        proxy_buffers 8 32k;
        proxy_buffer_size 64k;

        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-NginX-Proxy true;
    }
}

Start SeaDoc server server with the following command
```
docker compose up -d
```
Modify Seafile server's configuration and start SeaDoc server
Warning

After using a reverse proxy, your SeaDoc service will be located at the /sdoc-server path of your reverse proxy (i.e. xxx.example.com/sdoc-server). For example:
- Proxy server host: xxx.example.com
- SeaDoc server: seadoc.example.com:8888
Then SEADOC_SERVER_URL will be
```
http{s}://xxx.example.com/sdoc-server
```
Modify .env in your Seafile-server host:
```
ENABLE_SEADOC=true
SEADOC_SERVER_URL=https://seafile.example.com/sdoc-server
```
Restart Seafile server
Deploy in Docker (including cluster mode)Deploy from binary packages
docker compose down docker compose up -d
cd /opt/seafile/seafile-server-latest ./seahub.sh restart

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.