Installation

Choose npm to run Atlas Docs without a source checkout, Docker for a container, or source for development. You can run it on your computer or self-host on a server. The defaults below use localhost. For internet access, protect the entire app and its API with authentication at your proxy or gateway: Atlas Docs has no built-in login, user permissions, or public read-only mode.

npm

Install Node.js 22.12 or newer, then run:

npx atlas-docs@latest

Keep the terminal open. Open the local URL printed there (normally http://127.0.0.1:17430). The default library is atlas-docs-data in the directory where you ran the command.

For regular use:

npm install -g atlas-docs
atlas-docs

See npm installation for library selection, updates, and troubleshooting.

Docker

Install Docker with Docker Compose. Node.js is not required on the host.

Download docker-compose.hub.yml, open a terminal in its directory, and run:

docker compose -f docker-compose.hub.yml up -d

Open http://127.0.0.1:17430. The Compose file uses the published ezwaytechvn/atlas-docs image and persistent named volumes for your library and upgrade backups.

See Docker installation and updates. Keep both volumes when updating; docker compose down -v deletes them.

From source

Requires Git and Node.js 22.12 or newer.

git clone https://github.com/ezway-tech/atlas-docs.git
cd atlas-docs
npm run setup
npm run bootstrap
npm run dev

Open http://127.0.0.1:3000. A source checkout uses its data/ directory by default. Bootstrap creates an empty library without replacing existing documents.

For a production build, run npm run build, then npm start. See operations for data paths, backups, and updates.