commonplace-wiki/commonplace
A free wiki alternative, based on Git and OpenKnowledge Format. - commonplace-wiki/commonplace
1 stars · 0 forks · 0 watchers
README
Commonplace is an open-source wiki, knowledge base and Confluence alternative, based on a Git repository following Open Knowledge Format, with a nice UI. Documentation: commonplace.wiki (itself a Commonplace wiki for its knowledgebase)
Features
Beautiful UI: A familiar look and feel, but less bloated. Just a frontend: Commonplace is a stateless frontend. Everything is persisted in your Git repository. GitHub and GitLab: Works with repositories on github.com, gitlab.com, or a self-hosted GitLab. The provider's login and permission model controls who has read and write access to the wiki. Support for public and private repos. Open Knowledge Format: Google's universal format to collect knowledge and relationships. Markdown Editor: A nice editor with just the right feature set. Good support for code snippets, drag & drop, screenshots and rich formatting. Knowledge Graph: An interactive graph of all pages, connected by the links between them and the folder structure. AI friendly: The MCP server /api/mcp lets AI agents search, read, and write wiki pages and relationships to serve as the business knowledge for your agents. See the MCP docs. Or just point your agent to the Git repo. Confluence Migration Skill: Ask your coding agent to run the confluence-to-commonplace skill to migrate a Confluence space to Commonplace.
Try locally The fastest way to try Commonplace with a local Git repository: git_repo=$(mktemp -d) && git init -q "$git_repo" && echo "Created Git repository: $git_repo" docker run -p 3000:3000 \ -v "$git_repo":/repo -e GIT_REPO=/repo \ commonplacewiki/commonplace Open http://localhost:3000. Quickstart In production, the knowledge lives in a private or public GitHub or GitLab repository. You need to set up a GitHub App or GitLab OAuth App to pull the repo and to authenticate users. You can use the https://commonplace.wiki/setup which guides you to the setup. docker run -p 3000:3000 \ -e GIT_REPO=https://github.com/owner/repo \ -e GITHUB_CLIENT_ID=... \ -e GITHUB_CLIENT_SECRET=... \ -e SESSION_SECRET=$(openssl rand -hex 32) \ commonplacewiki/commonplace If the repository is public, the wiki is readable without signing in. Reading a private repository and editing pages require it. Refer to the documentation for all config options. For GitLab wikis (gitlab.com or self-hosted), see the GitLab guide. Additional installation methods, such as Kubernetes, Azure, and Vercel, are covered in the Installation docs. Local Setup (from source) cp .env.example .env.local # set at least GIT_REPO npm install npm run dev Open http://localhost:3000 and sign in. Read more https://www.commonplace.wiki/