Docshub with Docker
How to start the application using Docker
Docker
2024-09-04
Docker compose
Start and build the DocsHub app with the following compose.
# docker-compose.yml
services:
docshub:
container_name: docshub
image: atmgrupomaggioli/docshub:latest
ports:
- "4321:4321"
restart: unless-stopped
volumes:
- ./docs:/app/src/content/docs
- ./images:/app/public/images
environment:
DOCUMENTATION_TITLE: "Example Documentation title"
VERSION: "0.0.1"
REPOSITORY_TYPE: "github"
REPOSITORY_URL: "https://github.com/atmgrupomaggioli/docshub"
docker compose up -d --build
Additionally, you have a multi-platform image for linux/amd64 and linux/arm64 with the tag multiplatform
Docker run
Alternatively, if you donβt have Docker Compose
You can start the DocsHub Docker environment using the following docker run command.
docker run -d \
--name docshub \
-p 4321:4321 \
--restart unless-stopped \
-v ./docs:/app/src/content/docs \
-v ./images:/app/public/images \
-e DOCUMENTATION_TITLE="Example Documentation title" \
-e VERSION="0.0.1" \
-e REPOSITORY_TYPE="github" \
-e REPOSITORY_URL="https://github.com/atmgrupomaggioli/docshub" \
atmgrupomaggioli/docshub:latest