vdoc

Multi version documentation hosting.

Basic usage

Run vdoc with python

pip install vdoc
vdoc run

Run vdoc with docker

docker run -p 8080:8080 -v ./vdoc-docs:/srv/vdoc/docs/ voraus.jfrog.io/docker/vdoc:latest

Building vdoc

# Prepare development environment
npm ci
python -m venv venv
source venv/bin/activate
pip install --upgrade pip tox

# Build UI
npm run build

# Build docs
tox run -e docs

# Build python package
tox run -e build

# Build local docker image
docker build -t vdoc:latest .

Configuration

vdoc can be configured via environment variables. Internally, it uses pydantic-settings for building the configuration. All configuration environment variables are prefixed with VDOC_:

VDoc Configuration

Environment variable	Explanation	Default
VDOC_DOCS_DIR	The directory to which all project documentations will be uploaded.	/srv/vdoc/docs/
VDOC_API_USERNAME	The username required for uploading documentations via the API.	admin
VDOC_API_PASSWORD	The password required for uploading documentations via the API.	admin
VDOC_BIND_ADDRESS	The application bind address.	0.0.0.0
VDOC_BIND_ADDRESS	The application bind port.	8080