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

Nicolas Giard ae82e2e9d0 feat: added japanese choice 7 ani în urmă
.github 6ff78729be misc: activating open collective 8 ani în urmă
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) 8 ani în urmă
assets 5312f5320a feat: updated icons to Nucleo 8 ani în urmă
client 516220bdda feat: delete a page 7 ani în urmă
npm 61fe3d3d8b feat: npm install execute OS specific install script 8 ani în urmă
server ae82e2e9d0 feat: added japanese choice 7 ani în urmă
test 8da98ce75a fix: puglint path 8 ani în urmă
tools 7957a12216 feat: Persian locale + RTL initial support + browser locales fixes 8 ani în urmă
.editorconfig c6853a0315 User delete feature 8 ani în urmă
.eslintignore 5189ec3835 Migrated to Fusebox 8 ani în urmă
.eslintrc.json f577a8134e refactor: editor codeblock -> Vue component 8 ani în urmă
.gitattributes b035a68ca4 Base Project Files 9 ani în urmă
.gitignore dca237267a add sublime project to gitignore 8 ani în urmă
.npmrc 7291ec9562 fix: lock dependencies 8 ani în urmă
.yarnrc 7291ec9562 fix: lock dependencies 8 ani în urmă
CHANGELOG.md 3371651990 docs: updated changelog 7 ani în urmă
CONTRIBUTING.md 6ff78729be misc: activating open collective 8 ani în urmă
LICENSE 5bec7ff5c5 Initial commit 9 ani în urmă
README.md 0b893da414 docs: updated latest release 7 ani în urmă
config.sample.yml 7957a12216 feat: Persian locale + RTL initial support + browser locales fixes 8 ani în urmă
package.json 4db1c443d5 docs: updated version number 7 ani în urmă
wercker.yml a323128014 fix: wercker 8 ani în urmă
wiki.js d4b73be1e7 refactor: moved server content to /server 8 ani în urmă
yarn.lock 516220bdda feat: delete a page 7 ani în urmă

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
  • 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.

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]