Deploying a Simple and Usable ShowDoc Document System with Docker

ShowDoc is an excellent online tool for IT teams to create API documentation, technical documentation, data dictionaries, and online Excel documents using Markdown syntax.

ShowDoc offers an online version that you can register and use directly: https://www.showdoc.com.cn/. If your team requires it, you can also choose private deployment. This article shares how to deploy ShowDoc using Docker.

Docker Deployment of ShowDoc

Deploying ShowDoc with Docker is very simple; you only need the following command:

docker run -d --name showdoc --user=root --privileged=true -p 4999:80 \
-v /showdoc_data/html:/var/www/html/ star7th/showdoc

• 4999: Access port, which can be modified.
• /showdoc_data/html: Data storage directory, which can be modified.

After successful deployment, access it via http://IP:4999. The default username and password are showdoc/123456.

Additionally, the administrator username showdoc seems to be unchangeable; I (xiaoz) could not find a way to modify it. If you discover a solution, please leave a comment.

Docker Compose Deployment

If you choose to deploy using Docker Compose, first create a docker-compose.yaml file with the following content:

version: '3.3'
services:
    showdoc:
        container_name: showdoc
        privileged: true
        ports:
            - '4999:80'
        volumes:
            - './data:/var/www/html/'
        image: star7th/showdoc

Run the command docker-compose up -d to start. After successful deployment, access it via http://IP:4999. The default username and password are showdoc/123456.

Access via Bound Domain

After Docker deployment, the default access method is http://IP:4999. To access via a domain name, you can use Nginx reverse proxy. Below is an example configuration for Nginx reverse proxy:

server {
    listen       80;
    server_name  test.showdoc.com.cn;
    client_max_body_size 1000m;
    location ^~ / {
        proxy_pass http://127.0.0.1:4999/;
        proxy_redirect off;
        proxy_connect_timeout 90;
        proxy_send_timeout 90;
        proxy_read_timeout 90;
        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 http_user_agent $http_user_agent;
    }
}

Screenshots

ShowDoc has a very clean interface. Here are a few screenshots.

Conclusion

The ShowDoc document system is very simple and suitable for startups or small teams. Additionally, deploying ShowDoc with Docker is straightforward. If you are looking for an open-source document system, I recommend trying ShowDoc.

• ShowDoc Help Documentation: https://www.showdoc.com.cn/help/1385767280275683
• GitHub Open Source Address: https://github.com/star7th/showdoc