showdoc Docker & Self-Hosted Deployment

GitHub

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具

12,842 stars PHP PHP 1 file · ~7,244 tokens #api#document#documentation-tool#showdoc
RAW Compose
1. Pull Image (DOCKERHUB) docker pull star7th/showdoc
2. Docker Run (1-Click Launch) docker run -d --name showdoc -p 4999:4999 --restart always star7th/showdoc:latest
3. Podman Run podman run -d --name showdoc -p 4999:4999 --restart always star7th/showdoc:latest
4. Skopeo Inspect (Zero-Pull Manifest) skopeo inspect docker://docker.io/star7th/showdoc:latest
5. ORAS Pull (OCI Artifact) oras pull star7th/showdoc:latest
6. Compose Deployment docker compose up -d
docker-compose.yml
Download .yml 

services:
  showdoc:
    ## image + build 同时设置：
    ##   - 本地已有 image：直接使用；本地没有：默认先 pull，失败才用 build 本地构建；
    ##   - 强制重新构建：docker compose build 或 docker compose up --build（产物以 image 打标签）。
    ##   - 国内构建: docker compose build --build-arg IN_CHINA=true
    ##   - arm/v7 等平台: BASE_IMAGE=wordpress:php8.1 docker compose build
    image: star7th/showdoc:latest
    build:
      context: ./
      args:
        - IN_CHINA=${IN_CHINA:-false}
        - BASE_IMAGE=${BASE_IMAGE:-webdevops/php-nginx:8.3-alpine}
    environment:
      IN_CHINA: ${IN_CHINA:-false}
    hostname: showdoc
    ports:
      - 4999:80
    volumes:
      ## 兼容历史版本文件
      - /showdoc_data:/showdoc_data_old
      - ./showdocdata/html:/var/www/html
    restart: always
    tty: true