What is Wiki.js used for?

Wiki.js is listed as a Productivity tool on TiloBox. Review the overview, features, and official documentation on this page to decide whether it solves your specific workflow.

How do I get started with Wiki.js?

Start with the project's GitHub repository and official website for supported installation and deployment instructions. Test the setup with representative data or a small project before rolling it out more widely.

What license does Wiki.js use?

Wiki.js is listed under the AGPL-3.0 license. Read the complete license text and the project's notices before using, modifying, or distributing the software.

Is Wiki.js ready for production use?

Production readiness depends on your requirements. Review maintenance activity, security practices, documentation, backup and upgrade procedures, and compatibility with your stack; then validate it in a non-production environment.

Is Wiki.js an alternative to MediaWiki?

Wiki.js is listed as an alternative to MediaWiki. Compare the core workflow, deployment model, integrations, and licensing against your must-have requirements before switching.

Productivity Alternative to MediaWiki Alternative to Confluence

Wiki.js

The most powerful and extensible open-source Wiki software alternative to Confluence.

View on GitHub Visit website

LicenseAGPL-3.0

GitHub stars28.8k

Last commit1 weeks ago

Tags6 topics

WikiGit SyncNodejsKnowledge BaseSelf HostedDocumentation

Overview

Why consider Wiki.js?

Wiki.js is a modern, extensible wiki application built on Node.js and PostgreSQL. It features multiple editors (Markdown, Visual, Code), Git storage sync, and enterprise authentication.

Guided learning

Learn Wiki.js by building

Practical setup notes, real use cases, and copy-ready examples in one focused guide.

3 min read 10 sections

In this guide10 sections

What is Wiki.js?

Wiki.js is a modern, powerful open-source wiki and documentation engine built with Node.js, Vue.js, and PostgreSQL. It serves as an extensible, self-hosted alternative to proprietary enterprise wikis like Atlassian Confluence, Notion, and legacy software like MediaWiki.

Wiki.js offers deep flexibility: choose your preferred authoring editor (Markdown, Visual WYSIWYG, Raw HTML, AsciiDoc, or Code), synchronize all documentation bidirectionally with Git repositories (GitHub, GitLab), and integrate enterprise Single Sign-On (SSO) with extensive permission rules.

Who Is It For?

Engineering & DevOps Teams: Documenting technical architecture with Git synchronization and Markdown code formatting.
Enterprise Organizations: Centralizing corporate knowledge bases with Active Directory / LDAP and OAuth SSO integration.
Open-Source Projects: Publishing multi-lingual user guides and software documentation with full-text search.

Key Features

Multiple authoring editors: Markdown with live preview, Visual WYSIWYG, AsciiDoc, Raw HTML, and Code editors.
Bidirectional Git storage sync: Automatically commit and push wiki edits to GitHub, GitLab, or custom Git remotes.
Built-in multi-lingual translation engine: Manage and translate documentation across dozens of languages.
Comprehensive search backends: Integrated Database search, Elasticsearch, Algolia, and Postgres Trigram search.
Enterprise authentication integrations: Google, GitHub, Microsoft, Keycloak, Authentik, Okta, SAML 2.0, and LDAP.

Deploying Wiki.js with Docker Compose

yaml

1version: '3.7'

3services:

4 wikijs:

5 image: ghcr.io/requarks/wiki:2.5.314

6 container_name: wikijs

7 restart: unless-stopped

8 ports:

9 - "3000:3000"

10 environment:

11 - DB_TYPE=postgres

12 - DB_HOST=db

13 - DB_PORT=5432

14 - DB_USER=wikijs

15 - DB_PASS=secure_wikijs_password

16 - DB_NAME=wiki

17 depends_on:

18 - db

20 db:

21 image: postgres:15-alpine

22 container_name: wikijs_db

23 restart: unless-stopped

24 volumes:

25 - ./pgdata:/var/lib/postgresql/data

26 environment:

27 - POSTGRES_DB=wiki

28 - POSTGRES_USER=wikijs

29 - POSTGRES_PASSWORD=secure_wikijs_password

Start the instance:

bash

1docker compose up -d

Navigate to http://localhost:3000 in your browser to complete administrator onboarding and configure your first wiki page.

Practical Use Cases

1. Git-Backed Developer Knowledge Base

An engineering team authors wiki articles in Markdown; Wiki.js automatically commits all changes to a private GitHub repository, maintaining version histories and Git diffs.

2. Multi-Lingual Product Documentation

A SaaS company publishes help documentation in English, Spanish, and German, utilizing Wiki.js's native multi-lingual page localization features.

3. Corporate Intranet Wiki with SSO

An enterprise connects Wiki.js to corporate Authentik / Keycloak OIDC, granting internal employees instant single sign-on access to company documents.

Troubleshooting and Limitations

Search Engine Selection: For large wikis with thousands of pages, configure PostgreSQL full-text search or Elasticsearch in Administration -> Search to ensure fast query indexing.
Git Sync SSH Keys: When configuring Git storage synchronization, generate a dedicated SSH key pair within the Wiki.js admin dashboard and register the public key in your GitHub repository deploy keys.

Official Resources

Official Website: https://js.wiki
GitHub Repository: https://github.com/Requarks/wiki
Documentation: https://docs.requarks.com

Related tools

More options with a similar category or technology profile.

McFly

Fly through your shell history with an intelligent neural network search engine.

cheat

Interactive command-line cheatsheets for system administrators and software engineers.

Pipenv

Python development workflow for humans uniting Pipfile, pip, and virtualenv.

Rye

Comprehensive Python package and workspace management tool written in Rust.