Skip to content
Legacy version (1.x) of Wiki.js
CSS JavaScript Vue HTML Dockerfile
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode
assets
client
npm
server
test
tools
.editorconfig
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.npmrc
.yarnrc
CHANGELOG.md
CONTRIBUTING.md
CURRENT Create CURRENT Feb 15, 2019
LICENSE
README.md
config.sample.yml
package.json
wercker.yml
wiki.js
yarn.lock

README.md

Wiki.js

⚠️ This repository is for the legacy 1.x version of Wiki.js. It's highly recommended to use the latest version instead.


Release License Backers on Open Collective Sponsors on Open Collective Downloads Docker Pulls
Build Status Codacy Badge Standard - JavaScript Style Guide Twitter Follow

A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown

Donate

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 sponsor, becoming a patron, donating to our OpenCollective, via Paypal or via Ethereum (0xe1d55c19ae86f6bcbfb17e7f06ace96bdbb22cb5).

Become a Sponsor Become a Patron Donate on OpenCollective Donate via Paypal
Donate via Ethereum Donate via Bitcoin Buy a T-Shirt

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.

Docker / Cloud Install

A docker image is available on Docker Hub.
You can also use a Dockerfile (see example) or Docker Compose (see example) to run Wiki.js.
Docker Image

Deploy to Heroku using this pre-built deployment template:
Deploy to Heroku

Deploy to IBM Cloud Foundry using this pre-built deployment template (thanks to @seafre):
Deploy to IBM Cloud

Demo

The legacy Wiki.js documentation site is actually running Wiki.js! Check it out »

We do not provide a demo with write access because of potential security / spam issues. The best way to try it is to install it on your own server / computer. It's easy!

Milestones

1.0.117 - Stable

Note: This is the last 1.x release, no new features are being developed in the 1.0 branch. Consider upgrading to the latest major version.

  • Fixed: Upgrade to patched Google auth module (Google+ deprecation)

1.0.102 - Stable

  • Added: Open ID Connection provider (thanks to @sazulo)
  • Added: Turkish locale is now available (thanks to @MrSimsek)
  • Fixed: Paths in git commits are no longer escaped (thanks to @EricFromCanada)
  • Fixed: Fixed potential bug when uploading certain images (thanks to @Gnurdle)

Twitter

Follow our Twitter feed to learn about upcoming updates and new releases!
Twitter Follow

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

Algolia
Algolia for providing access to their incredible search engine.

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

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

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]

You can’t perform that action at this time.