Skip to content

Commit de42637

Browse files
committed
add seadoc
1 parent 70da3ab commit de42637

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Report Design (seadoc)
2+
3+
<!-- md:version 5.3 -->
4+
<!-- md:flag enterprise -->
5+
6+
SeaDoc is a Docker container required for the new SeaTable **Report Design** plugin. With this plugin, you can easily create multi-page technical reports, summaries, and other documents.
7+
8+
!!! example "Currently in Beta"
9+
10+
The **Report Design** plugin is currently in beta. We welcome your feedback. The official release is planned for version 6.0.
11+
12+
## Installation Requirements
13+
14+
1. SeaTable Enterprise Edition installed and running
15+
2. Firewall configured to allow traffic on port 6240
16+
3. System admin to install both the report design plugin and this seadoc editor (server component)
17+
18+
## SeaDoc Installation
19+
20+
Follow these steps to deploy the seadoc editor on the same node as the seatable-server:
21+
22+
#### Update .env file
23+
24+
Like with all additional components you need to add `seadoc.yml` to the `COMPOSE_FILE` variable in your `.env` file.
25+
26+
Simply copy and paste (:material-content-copy:) the following code into your command line:
27+
28+
```bash
29+
sed -i "s/COMPOSE_FILE='\(.*\)'/COMPOSE_FILE='\1,seadoc.yml'/" /opt/seatable-compose/.env
30+
```
31+
32+
#### Launch the seadoc editor
33+
34+
Simply run the following commands to (re-)start SeaTable and seadoc container.
35+
36+
```bash
37+
cd /opt/seatable-compose && \
38+
docker compose up -d
39+
```
40+
41+
#### Verify Installation
42+
43+
After a few seconds, check `https://<your-seatable-url>:6240`. You should see:
44+
45+
```
46+
Welcome to sdoc-server. The current version is ...
47+
```
48+
49+
This confirms that the `seadoc` container is operational. If you don't see this message, check that port 6240 is allowed and the container logs.
50+
51+
## Final Steps
52+
53+
With the server-side installation finished, you can now install the **report design plugin** from the SeaTable admin interface and start using this powerful reporting tool.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ nav:
154154
- Python Pipeline: installation/components/python-pipeline.md
155155
- Whiteboard: installation/components/whiteboard.md
156156
- n8n: installation/components/n8n.md
157+
- Report Design: installation/components/seadoc.md
157158
- Office Editors:
158159
- Collabora: installation/components/collabora.md
159160
- OnlyOffice: installation/components/onlyoffice.md

0 commit comments

Comments
 (0)