Go to file

Nicolas Giard b89b643bdb Create auto_assign.yml		2019-01-27 23:44:22 -05:00
.github	Create auto_assign.yml	2019-01-27 23:44:22 -05:00
.vscode	feat: save page	2018-07-22 00:29:39 -04:00
client	fix: tables styling	2019-01-19 16:57:25 -05:00
dev	misc: remove publishing docker build step	2019-01-19 02:25:35 -05:00
server	fix: setup locale crash	2019-01-20 13:10:06 -05:00
.babelrc	fix: setup issues + webpack improvements	2018-09-29 15:39:09 -04:00
.editorconfig	feat: register validation + create + admin improvements	2018-12-17 00:51:52 -05:00
.eslintignore	refactor: dev optimizations + improvements	2018-03-17 22:41:16 -04:00
.eslintrc.yml	feat: webpack refactor	2018-01-26 00:32:53 -05:00
.gitattributes	Base Project Files	2016-08-16 20:56:55 -04:00
.gitignore	fix: mysql + sqlite incompatible queries	2018-08-15 21:57:28 -04:00
.npmrc	chore: updated dependencies	2017-08-12 17:26:27 -04:00
.nvmrc	fix: add nvmrc file	2018-10-19 18:37:04 -04:00
CHANGELOG.md	Merge remote-tracking branch 'origin/master' into dev	2017-10-15 17:13:35 -04:00
config.sample.yml	fix: dockerfile env vars	2018-11-04 12:55:21 -05:00
LICENSE	Initial commit	2016-08-16 15:35:26 -04:00
Makefile	feat: admin - manage groups + permissions + page rules	2018-12-29 21:30:51 -05:00
package.json	docs: update beta readme	2019-01-20 17:54:22 -05:00
README.md	docs: update beta readme	2019-01-20 17:54:22 -05:00
wiki.js	fix: dark mode handling	2018-12-01 23:03:14 -05:00
yarn.lock	feat: user menu + jwt certs + UI fixes	2018-12-02 21:42:43 -05:00

README.md

A modern, lightweight and powerful wiki app built on NodeJS

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

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

Check out our documentation site, it's running Wiki.js!

Milestones

📑 See project board to keep track of current progress.

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!