Wiki.js | A modern and powerful wiki app built on Node.js

NGPixel cbaa20da3f feat: telemetry client module 7 éve
.github 6ff78729be misc: activating open collective 7 éve
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) 8 éve
assets 501f0a9a53 feat: auth strategies over GraphQL + svg loading 7 éve
client cbaa20da3f feat: telemetry client module 7 éve
server cbaa20da3f feat: telemetry client module 7 éve
test 8da98ce75a fix: puglint path 8 éve
themes 3493bd5781 feat: themes folder + telemetry option in setup 7 éve
tools e183167c9b Merge remote-tracking branch 'origin/master' into dev 7 éve
.babelrc 2be7f71be8 feat: fusebox updates + vue-component-plugin 7 éve
.editorconfig c6853a0315 User delete feature 8 éve
.eslintignore 5189ec3835 Migrated to Fusebox 8 éve
.eslintrc.json 2be7f71be8 feat: fusebox updates + vue-component-plugin 7 éve
.gitattributes b035a68ca4 Base Project Files 9 éve
.gitignore c2db365922 refactor: Dockerfile for VSTS 7 éve
.npmrc 7f955707b7 chore: updated dependencies 8 éve
.yarnrc 7f955707b7 chore: updated dependencies 8 éve
CHANGELOG.md e183167c9b Merge remote-tracking branch 'origin/master' into dev 7 éve
CONTRIBUTING.md 6ff78729be misc: activating open collective 7 éve
LICENSE 5bec7ff5c5 Initial commit 9 éve
README.md 3709b8e7be docs: updated README 7 éve
config.sample.yml cbaa20da3f feat: telemetry client module 7 éve
package.json cbaa20da3f feat: telemetry client module 7 éve
wercker.yml 35cb56c694 feat: file resolvers + pull changes from master 8 éve
wiki.js c26fae2ede feat: Kernel module 7 éve
yarn.lock cbaa20da3f feat: telemetry client module 7 éve

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]