wiki/README.md

A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown

• Official Website
• Documentation
• Requirements
• Change Log
• Feature Requests
• Milestones
• Chat with us
• Translations (We need your help!)
• Special Thanks

Documentation

• Installation Guide
• Admin Guide
• User Guide

Requirements

Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.).

• Node.js 6.11.1 or later
• MongoDB 3.2 or later
• Git 2.7.4 or later
• An empty Git repository (optional)

Read the full prerequisites article for full details.

Cloud Install

Docker, Azure and more coming soon!

Milestones

Current and upcoming milestones (major features only, see the changelog for complete list of features and bug fixes):

1.0.0 - Beta 13

• Color Themes
• Server-side TeX/MathML rendering
• Render line breaks by default (GitHub style)
• New Localization: German

1.0.1 - Stable

• Bug fixes release

2.0.0 - Dev

Breaking Changes: MongoDB is being phased out in favor of PostgreSQL + Redis. An upgrade tool will be provided to migrate existing data to the new system.

• Migrate to PostgreSQL + Redis datastore
• History / Revert to previous version
• Optional Two-Steps Authentication (2FA)
• Docker support + Auto compile/publish to Docker Hub
• Support sub-directory installations (e.g. example.com/wiki)
• Persist system settings to database instead of file-based

Future

• User Groups + Better permissions management
• Insert Link modal in Editor
• Better simultaneous user editing handling
• Preview changes directly from the editor, without saving
• Upgrade from web UI

Gitter

Want to discuss features, ideas or issues? Join our gitter channel. We are very active and friendly!

Twitter

Follow our Twitter feed to learn about upcoming updates and new releases!

Translations

We are looking for translators to make Wiki.js available in multiple languages. If your language is not listed below and would like to contribute to this project, contact us on our gitter channel and we'll provide you with the necessary tool to add translations, no coding required!

Languages that are already translated:

• English
• Chinese - Thanks to @choicky
• French
• German - Thanks to @joetjengerdes
• Korean - Thanks to @junwonpk
• Portuguese - Thanks to @felipeplets
• Russian - Thanks to @efimlosev
• Spanish - Thanks to @MatiasArriola

Special Thanks

Browserstack for providing access to their great cross-browser testing tools.

DigitalOcean for providing hosting of the Wiki.js documentation site.