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.
Tip
It's highly recommended to run Wiki.js using Docker. It includes all necessary dependencies (minus the database) and provides the easiest ugprade path.
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. Workers are responsible for maintenance tasks, updates, webhooks, search index rebuild, final page render, etc.
Linux systems should have at least 1GB of RAM to run Wiki.js. Windows and macOS systems usually require a bit more RAM.
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 requires internet access to perform certain functions. If you block all connections by default via a firewall, you must ensure the following are allowlisted:
Wiki.js listens over HTTP / WebSockets on the port you defined in the config.yml file (3000 by default).
The following endpoints called by Wiki.js for various functions:
| Endpoint | Port | Reason |
|---|---|---|
api.github.com |
443 (HTTPS) |
Check for new versions / updates |
github.com |
443 (HTTPS) |
Fetch locales metadata and strings |
api.iconify.design |
443 (HTTPS) |
Fetch and search icon sets |
Important
In addition to the endpoints above, you must also allow the endpoints required for the authentication and storage modules you enable. Refer the each module documentation for the endpoints to allow.
Privacy Focused
Wiki.js doesn't send any telemetry nor does it make any secret calls. We hate tracking as much as you do.
Wiki.js requires a dedicated sub-domain / domain (e.g. wiki.example.com).
Warning
You CANNOT install Wiki.js to a sub-folder (e.g.
/wiki/) on an existing hostname. This use case is NOT supported and will not be.
Wiki.js requires a PostgreSQL database. It is not part of Wiki.js and it will not be installed for you. You're expected to provide an empty database for Wiki.js to use, and preferably a unique user / pass to connect to it.
Supported versions:
Note
The
ltreeandpg_trgmextensions must be available in your PostgreSQL installation. These extensions are usually included by default in most installations. The official PostgreSQL docker image already includes them.
The Node.js runtime is required and must be installed on the system (unless using the Docker container image, in which case it is already included).
Supported versions:
Warning
Earlier versions of Node.js are NOT compatible and will NOT work. It requires various features introduced in Node.js 26.
The following browsers are supported:
Note
Only the latest stable version of these browsers are supported.