Wiki.js runs on virtually any system where Node.js is supported.
This means it runs on Linux, macOS, Windows as well as container solutions such as Docker / Kubernetes and Heroku.
Wiki.js runs perfectly fine on a single CPU core. However, 2 cores or more are recommended to fully make use of the background workers.
Linux systems should have at least 1GB of RAM to run Wiki.js. Windows and macOS systems usually require a bit more RAM.
While the process itself usually sits at around 70MB of RAM, some events (such as page rendering, indexing, etc.) result in short bursts in RAM usage.
Storage requirements are based on the content you will enter. Wikis that consists almost exclusively of text are not likely to exceed a few megabytes. However, as soon as you upload images, videos or other files, you should plan your storage requirements accordingly.
At least 1 GB of storage dedicated to Wiki.js is recommended.
Wiki.js will automatically check for new updates, languages, themes, etc. from time to time. You can read more about what data is downloaded.
An alternate method of sideloading files is also available if your environment is cut from the internet.
Wiki.js requires a dedicated sub-domain / domain (e.g.
wiki.example.com). You cannot map Wiki.js to a subfolder.
For best performance, features and future compatibility, it's highly recommended to use PostgreSQL.
It's recommended you use the latest version of PostgreSQL when possible.
Note that in order to use the PostgreSQL search module, the
pg_trgmextension must be available on the host. The extension is part of the
postgresql-contribpackage in most Linux distributions. The docker PostgreSQL image already includes the extension.
Wiki.js is also compatible with the following database systems:
These engines (MySQL, MariaDB, MS SQL Server and SQLite) will NOT be supported in the next major version of Wiki.js. Make sure you understand the implications of migrating your database to PostgreSQL if you plan on upgrading to 3.x+ in the coming years. An export + import tool will be made available at / shortly after release.
SQLite is not recommended for production deployments.
You're expected to have installed one of these database engines already (either locally, on another server or using a cloud service). Wiki.js requires an empty database and preferably a unique user / pass to connect to the database.
The Node.js runtime is required. The following versions are supported:
Wiki.js will NOT run on older versions such as 8.x, 6.x or any version below 10.12!
Odd-numbered versions (e.g.
17.x) are NOT supported.
Skip this requirement! You don't need to install Node.js on your machine! It's included in the Docker image already.
Wiki.js doesn't need any actual web server (such as nginx or Apache). However, you might need to put a reverse proxy in front of Wiki.js if you require advanced network / DNS configuration.
The following browsers are supported:
Note that only the latest stable version of these browsers are supported. All browsers are automatically updated in the background by default.
There's limited compatibility with IE11. Users will be able to read content but not perform any editing action or use interactive features.