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

Nicolas Giard 093d3aa8fa docs: updated 2.0 milestones há 8 anos atrás
.github 6ff78729be misc: activating open collective há 8 anos atrás
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) há 8 anos atrás
assets 5312f5320a feat: updated icons to Nucleo há 8 anos atrás
client 516220bdda feat: delete a page há 8 anos atrás
npm 61fe3d3d8b feat: npm install execute OS specific install script há 8 anos atrás
server 7d323d1f6e Small fixes and adds in german language há 8 anos atrás
test 8da98ce75a fix: puglint path há 8 anos atrás
tools c2db365922 refactor: Dockerfile for VSTS há 8 anos atrás
.editorconfig c6853a0315 User delete feature há 8 anos atrás
.eslintignore 5189ec3835 Migrated to Fusebox há 8 anos atrás
.eslintrc.json f577a8134e refactor: editor codeblock -> Vue component há 8 anos atrás
.gitattributes b035a68ca4 Base Project Files há 9 anos atrás
.gitignore c2db365922 refactor: Dockerfile for VSTS há 8 anos atrás
.npmrc 7291ec9562 fix: lock dependencies há 8 anos atrás
.yarnrc 7291ec9562 fix: lock dependencies há 8 anos atrás
CHANGELOG.md 7b16a7ea6c docs: changelog link fix há 8 anos atrás
CONTRIBUTING.md 6ff78729be misc: activating open collective há 8 anos atrás
LICENSE 5bec7ff5c5 Initial commit há 9 anos atrás
README.md 093d3aa8fa docs: updated 2.0 milestones há 8 anos atrás
config.sample.yml ea0d2ff986 feat: added japanese to lang list há 8 anos atrás
package.json c2db365922 refactor: Dockerfile for VSTS há 8 anos atrás
wercker.yml a323128014 fix: wercker há 8 anos atrás
wiki.js d4b73be1e7 refactor: moved server content to /server há 8 anos atrás
yarn.lock c2db365922 refactor: Dockerfile for VSTS há 8 anos atrás

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!

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]