[![Chat on Gitter](https://img.shields.io/badge/chat-on_gitter-CC2B5E.svg?style=flat&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAAAOCAMAAADUg/YpAAAABlBMVEUAAAD///%2Bl2Z/dAAAAAXRSTlMAQObYZgAAABVJREFUeAFjwAUYYTQByAAh0WicAAAFnwAYeB5bLwAAAABJRU5ErkJggg==)](https://gitter.im/Requarks/wiki)
##### A modern, lightweight and powerful wiki app built on NodeJS
</div>
# :white_check_mark: STABLE v1.x version
**This repository is 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.
:point_right: **[Go to version 1.x instead](https://github.com/Requarks/wiki-v1)** :point_left:
**Version 2.0 should NOT be used in production! Once again, please use 1.x for now!**
---
# :construction: 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](https://wiki.js.org/)** *(Coming soon, pointing to 1.x for now)*
Wiki.js is an open source project that has been made possible due to the generous contributions by community backers. If you are interested in supporting this project, please consider [becoming a patron](https://www.patreon.com/requarks) or donating to our [OpenCollective](https://opencollective.com/wikijs).
<ahref="https://www.patreon.com/requarks">
<imgsrc="https://c5.patreon.com/external/logo/become_a_patron_button.png"alt="Become a Patron"/>
Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.) or using Docker!
- Node.js **10.12** 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](https://docs-beta.requarks.io/install/requirements) article for full details.
<h2align="center">Docker</h2>
Docker is the recommended way to go! Simply use Docker image: `requarks/wiki:beta`*(coming soon!)*
You can also use Docker Compose ([see example](https://github.com/Requarks/wiki/blob/dev/examples/docker-compose.yml)) to run Wiki.js with all dependencies.
<h2align="center">Demo</h2>
Check out our [documentation site](https://docs-beta.requarks.io), it's running Wiki.js!
<h2align="center">Milestones</h2>
:bookmark_tabs: See [project board](https://docs-beta.requarks.io/milestones) to keep track of current progress.
<h2align="center">Gitter</h2>
Want to discuss features, ideas or issues? Join our [gitter channel](https://gitter.im/Requarks/wiki). We are very active and friendly!
[![Chat on Gitter](https://img.shields.io/badge/chat-on_gitter-CC2B5E.svg?style=flat-square&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAAAOCAMAAADUg/YpAAAABlBMVEUAAAD///%2Bl2Z/dAAAAAXRSTlMAQObYZgAAABVJREFUeAFjwAUYYTQByAAh0WicAAAFnwAYeB5bLwAAAABJRU5ErkJggg==)](https://gitter.im/Requarks/wiki)
<h2align="center">Twitter</h2>
Follow our Twitter feed to learn about upcoming updates and new releases!
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](https://wikijs.threadless.com/)
<h2align="center">Translations</h2>
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](https://gitter.im/Requarks/wiki) and we'll provide you access to our translation tool, absolutely no coding required!
[DigitalOcean](https://m.do.co/c/5f7445bfa4d0) for providing hosting of the Wiki.js documentation site.
<h2align="center">Sponsors</h2>
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](https://opencollective.com/wikijs#sponsor)]