hhy5277 / wiki

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

A modern, lightweight and powerful wiki app built on NodeJS

✅ STABLE v1.x version

This repository will soon be used for the 2.0 BETA of Wiki.js.
It is highly recommended to use the 1.x version until a stable version of 2.0 is released. An easy and quick upgrade path will be provided to migrate from 1.x to 2.0.

👉 Go to version 1.x instead 👈

Version 2.0 should NOT be used in production! Once again, please use 1.x for now!

---

🚧 UNSTABLE v2.0 BETA version

This version is for testing and development purposes only! It is not ready for production and is still missing critical features. You cannot migrate 1.x data at this time!

• Official Website (Coming soon, pointing to 1.x for now)
• Documentation
• Requirements
• Demo
• Change Log
• Feature Requests
• Milestones
• Chat with us
• Donate
• T-Shirts Shop
• Translations (We need your help!)
• Special Thanks
• Contribute

Requirements

Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.) or using Docker!

• Node.js 10.14 or later
• One of the following supported database engines:
  • MySQL 5.7.8 or later
  • PostgreSQL 9.5 or later
  • MariaDB 10.2.7 or later
  • Microsoft SQL Server 2012 or later
  • SQLite 3.9 or later
• Redis 3.2 or later

Read the full prerequisites article for full details.

Docker

Docker is the recommended way to go! Simply use Docker image: requarks/wiki:beta (coming soon!)

You can also use Docker Compose (see example) to run Wiki.js with all dependencies.

Demo

Coming soon!

Milestones

📑 See project board to keep track of current progress.

2.0.0 - BETA

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.
• Modular approach to auth, editors, logging, search and storage.

Release Date: January 2019

Breaking Changes:

• MongoDB is being phased out in favor of PostgreSQL/MySQL/MSSQL/SQLite + Redis. An upgrade tool will be provided to migrate existing data to the new system.
• Node.js 10 LTS or later will be the minimum supported version.

2.0 Milestone:

• GraphQL API
• Migrate to Objection.js + Redis datastore
• Telemetry for analytics and crash reporting (Optional and fully anonymized)
• Docker support + Auto compile/publish to Docker Hub
• Make use of all available CPU cores, distributed jobs queue
• Modular authentication providers (+ new Auth0, Discord and Twitch providers)
• Persist system settings to database instead of file-based
• Shared kernel for both app and setup
• Improved installation wizard
• Modular logging providers
• New Login page
• Two-Factor Authentication (2FA)
• New Navigation Concept
• New Admin Area
  • UI
  • Locales
  • Manage Groups
  • Manage Users
  • Manage Authentication Strategies
  • Manage Editors
  • Manage Logging
  • Manage Navigation
  • Manage Rendering 🚀
  • Manage Search Engines
  • Manage Storage Targets
  • System Info
  • Developer Tools
  • Contribute
• New Cache Engine
• Requarks Graph
  • Countries
  • Locales + translations
• Modular editors
  • Markdown editor
    • Core Editor
    • Live Preview
    • Toolbar
  • Operations
    • Create
    • Update
    • Move / Rename
    • Delete
  • Dialogs
    • Properties
    • Image + File Manager
• Modular content parsers/renderers
  • Markdown
  • HTML
• Modular search engines
  • DB
• Modular storage engines
  • Git
  • Local Disk
• Multilingual versions of the same page (i18n)
• History / Revert to previous version 🚀
• User Groups + Better permissions management
• Tags per document / folder

🚀 = Currently in development

2.1 Milestone

• Comments / Discussion per document
• Profile page per user
• Diagrams as code (Mermaid module)
• Themes
• Additional search engines
  • AWS CloudSearch
  • Algolia
  • Azure Search
  • Elasticsearch
  • Manticore Search
  • Solr
  • Sphinx Search
• Additional storage engines
  • Dropbox
  • Google Drive
  • Amazon S3
  • Azure Blob Storage
  • DigitalOcean Spaces
  • Onedrive
  • Owncloud
  • SCP (SSH)
• Modular Editor: TinyMCE (wysiwyg)
• Kubernetes / Helm Installation

TBD Milestone

• Better simultaneous user editing handling
• High Availability support (multiple concurrent instances)

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!

T-Shirts Shop

Want to donate to this project but get something in return as well? Check out our amazing t-shirts for men, women and kids, as well as other goodies: Wiki.js Shop

Translations

We are looking for translators to make Wiki.js UI available in as many languages as possible. If you would like to contribute to this project, contact us on our gitter channel and we'll provide you access to our translation tool, absolutely no coding required!

Special Thanks

Algolia for providing access to their incredible search engine.

Browserstack for providing access to their great cross-browser testing tools.

Cloudflare for providing their great CDN, SSL and advanced networking services.

DigitalOcean for providing hosting of the Wiki.js documentation site.

Sponsors

Support this project by becoming a sponsor. Your logo will show up in the Contribute page of all Wiki.js installations as well as here with a link to your website! [Become a sponsor]

Backers

Thank you to all our backers! 🙏 [Become a backer]

Contributors

This project exists thanks to all the people who contribute. [Contribute].