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

NGPixel ca8451720f feat: setup wizard cleanup + upgrade UI hace 8 años
.github 57299dbabd docs: Updated issue template hace 8 años
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) hace 8 años
assets 501f0a9a53 feat: auth strategies over GraphQL + svg loading hace 8 años
client ca8451720f feat: setup wizard cleanup + upgrade UI hace 8 años
server ca8451720f feat: setup wizard cleanup + upgrade UI hace 8 años
test 8da98ce75a fix: puglint path hace 8 años
tools c26fae2ede feat: Kernel module hace 8 años
.babelrc 2be7f71be8 feat: fusebox updates + vue-component-plugin hace 8 años
.editorconfig c6853a0315 User delete feature hace 8 años
.eslintignore 5189ec3835 Migrated to Fusebox hace 8 años
.eslintrc.json 2be7f71be8 feat: fusebox updates + vue-component-plugin hace 8 años
.gitattributes b035a68ca4 Base Project Files hace 9 años
.gitignore ebe288a5b2 refactor: lazy-load simplemde + minimal lodash hace 8 años
.npmrc 7f955707b7 chore: updated dependencies hace 8 años
.yarnrc 7f955707b7 chore: updated dependencies hace 8 años
CHANGELOG.md 35cb56c694 feat: file resolvers + pull changes from master hace 8 años
LICENSE 5bec7ff5c5 Initial commit hace 9 años
README.md 35cb56c694 feat: file resolvers + pull changes from master hace 8 años
config.sample.yml 749766e9bd feat: queue handling hace 8 años
package.json c26fae2ede feat: Kernel module hace 8 años
wercker.yml 35cb56c694 feat: file resolvers + pull changes from master hace 8 años
wiki.js c26fae2ede feat: Kernel module hace 8 años
yarn.lock c26fae2ede feat: Kernel module hace 8 años

README.md

Wiki.js

Release License npm Downloads Twitter Follow
Build Status Codacy Badge Dependency Status Standard - JavaScript Style Guide Chat on Gitter

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

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.8 - Stable

Progress

  • Fix: Azure AD client Id is now referenced correctly (#219)
  • Fix: Git Branch is now referenced correctly (#215)
  • Updated dependencies

2.0.0 - Dev

Progress

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
    • Users
  • Migrate to PostgreSQL + Redis datastore
  • 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)

Future

  • Insert Link modal in Editor
  • Better simultaneous user editing handling
  • 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!
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.