Reading the repo
Reading the repo
How to install on Windows
Docmost is an open-source collaborative wiki and documentation software. It is an open-source alternative to Confluence and Notion.
Saved setup from 6 h ago
Will it work on my device?
Then run powershell -ExecutionPolicy Bypass -File .\setup.ps1. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: winget install Git.Git. The repo uses git submodules, so the clone fetches them too.
git clone --recurse-submodules https://github.com/docmost/docmost.git cd docmost
Node.js LTS (no version pinned)
winget install CoreyButler.NVMforWindows nvm install lts nvm use lts
Fill in secrets: APP_SECRET, JWT_TOKEN_EXPIRES_IN, AWS_S3_ACCESS_KEY_ID, AWS_S3_SECRET_ACCESS_KEY, AZURE_STORAGE_ACCOUNT_KEY, SMTP_PASSWORD, POSTMARK_TOKEN
Copy-Item .env.example .env
Needs: PostgreSQL, Redis
winget install Docker.DockerDesktop docker compose -f docker-compose.yml up -d
corepack enable pnpm install
pnpm dev
No reports for Windows yet.
Opens a chat with this manual already filled in, for Windows. It uses your own account; gitmanual sends nothing.