Wiki.js | A modern and powerful wiki app built on Node.js
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
NGPixel 82ea0b50fb
feat: config wizard UI improv. + upgrade from Mongo
7 years ago
.github misc: activating open collective 7 years ago
.vscode fix: eslint for vue components 7 years ago
assets feat: config wizard UI improv. + upgrade from Mongo 7 years ago
client feat: config wizard UI improv. + upgrade from Mongo 7 years ago
server feat: config wizard UI improv. + upgrade from Mongo 7 years ago
test fix: eslint for vue components 7 years ago
themes/default feat: themes folder + telemetry option in setup 7 years ago
tools feat: db + redis error handling, setup options, updated deps 7 years ago
.babelrc feat: fusebox updates + vue-component-plugin 7 years ago
.editorconfig User delete feature 8 years ago
.eslintignore Migrated to Fusebox 8 years ago
.eslintrc.yml feat: config wizard UI improv. + upgrade from Mongo 7 years ago
.gitattributes Base Project Files 8 years ago
.gitignore refactor: Dockerfile for VSTS 7 years ago
.npmrc chore: updated dependencies 7 years ago
.yarnrc chore: updated dependencies 7 years ago
CHANGELOG.md Merge remote-tracking branch 'origin/master' into dev 7 years ago
CONTRIBUTING.md misc: activating open collective 7 years ago
LICENSE Initial commit 8 years ago
README.md docs: updated README 7 years ago
config.sample.yml feat: config wizard UI improv. + upgrade from Mongo 7 years ago
package.json feat: db + redis error handling, setup options, updated deps 7 years ago
wercker.yml feat: file resolvers + pull changes from master 7 years ago
wiki.js feat: Kernel module 7 years ago
yarn.lock feat: db + redis error handling, setup options, updated deps 7 years ago

README.md

Wiki.js

Release License Backers on Open Collective Sponsors on Open Collective npm Downloads
Build Status Codacy Badge Standard - JavaScript Style Guide Chat on Gitter Twitter Follow

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

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

Deploy to Heroku

Docker Cloud, Azure, IBM Bluemix and more coming soon!

Docker

A docker Wiki.js image is available on Docker Hub:

Docker Image

You can also use a Dockerfile (see example) or Docker Compose (see example) to run Wiki.js.

Milestones

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

1.0.11 - Stable

Progress

Note: As 2.0 is under development, no new features are being developed in the 1.0 branch.

  • Japanese localization
  • Fix for name search when using OpenLDAP
  • Added referrer policy header

2.0.0 - Dev

Progress

Goals:

  • Decouple front-end and back-end completely.
  • All operations and queries will be made via GraphQL API.
  • New fully responsive layout, with better customization capabilities.
  • Full localization support, especially for non-latin languages.

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.

  • GraphQL API
    • Comments
    • Documents
    • Files
    • Folders
    • Groups
    • Rights
    • Settings
    • Tags
    • Translations
    • Users
  • Migrate to PostgreSQL + Redis datastore
  • Themes
  • New Login page
  • 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
  • User Groups + Better permissions management
  • Make use of all available CPU cores, distributed jobs queue
  • Tags per document / folder
  • Comments / Discussion per document
  • Profile page per user
  • Preview changes directly from the editor, without saving
  • Modular authentication providers
  • High Availability support (multiple concurrent instances)
  • Insert Link modal in Editor
  • Better simultaneous user editing handling

Gitter

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

Twitter

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

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:

Special Thanks

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

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

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]