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

Nicolas Giard 5919d14670 feat: loggers + search engines models 7 år sedan
.github e55c5805b4 dev: refactoring + lokalise fetch + process 7 år sedan
.vscode cb84df7a53 feat: save page 7 år sedan
client 9c6a4f6c20 refactor: logging + search modules PH 7 år sedan
dev 2483dce941 feat: dev docker-compose 7 år sedan
server 5919d14670 feat: loggers + search engines models 7 år sedan
.babelrc f27c1e86b1 feat: editor-modal-document UI 7 år sedan
.editorconfig c6853a0315 User delete feature 8 år sedan
.eslintignore 392cbe9388 refactor: dev optimizations + improvements 7 år sedan
.eslintrc.yml 6227690c94 feat: webpack refactor 7 år sedan
.gitattributes b035a68ca4 Base Project Files 9 år sedan
.gitignore 96f4e89020 fix: mysql + sqlite incompatible queries 7 år sedan
.npmrc 7f955707b7 chore: updated dependencies 8 år sedan
CHANGELOG.md e183167c9b Merge remote-tracking branch 'origin/master' into dev 7 år sedan
LICENSE 5bec7ff5c5 Initial commit 9 år sedan
Makefile 23f07381c2 feat: added Makefile + npm scripts for docker dev 7 år sedan
README.md 3709b8e7be docs: updated README 7 år sedan
config.sample.yml 9c6a4f6c20 refactor: logging + search modules PH 7 år sedan
docker-compose.yml 2483dce941 feat: dev docker-compose 7 år sedan
package.json 23f07381c2 feat: added Makefile + npm scripts for docker dev 7 år sedan
wiki.js 2817c72ec3 feat: core improvements + local fs provider + UI fixes 7 år sedan
yarn.lock 96f4e89020 fix: mysql + sqlite incompatible queries 7 år sedan

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]