Server

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.

CPU

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.

Memory

Linux systems should have at least 1GB of RAM to run Wiki.js. Windows and macOS systems usually require a bit more RAM.

Disk

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.

Note

The Wiki.js docker image image is quite large (~850MB) as it includes all extensions. This is not included in the recommendations above.

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:

Inbound Connections

Wiki.js listens over HTTP / WebSockets on the port you defined in the config.yml file (3000 by default).

Outbound Connections

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.

Hostname

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.

Database

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:

• PostgreSQL 18
• PostgreSQL 17
• PostgreSQL 16

Note

The ltree and pg_trgm extensions 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.

Node.js

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:

• Node.js 26

Warning

Earlier versions of Node.js are NOT compatible and will NOT work. It requires various features introduced in Node.js 26.

Supported Browsers

The following browsers are supported:

• Google Chrome (including Android version)
• Mozilla Firefox
• Apple Safari (including iOS version)

Note

Only the latest stable version of these browsers are supported.

Reverse Proxy

If your wiki is going to be behind a reverse proxy (e.g. nginx, Cloudflare Tunnel, etc.), you MUST ensure that:

• The following X-Forwarded-* headers are set:
  • X-Forwarded-Proto
  • X-Forwarded-Host
  • X-Forwarded-For
• WebSockets upgrades are allowed through.
• Once Wiki.js is installed, go to Administration Area Security and enable the Trust X-Forwarded-* Proxy Headers option.

This is necessary for authentication, rate limiting, audit log and live collaboration to function correctly. See below for example reverse proxy configurations:

Cloudflare Tunnel

Cloudflare already forwards the necessary headers.

NGINX

Here's an example configuration with the necessary headers set:

server {
  listen 80;
  server_name wiki.example.com;
  return 301 https://$host$request_uri;
}

server {
  listen 443 ssl;
  http2 on;
  server_name wiki.example.com;

  ssl_certificate     /etc/ssl/wiki.example.com/fullchain.pem;
  ssl_certificate_key /etc/ssl/wiki.example.com/privkey.pem;

  # At least the wiki's uploadMaxFileSize (10 MB by default); nginx's own default is 1 MB
  client_max_body_size 10m;

  location / {
    proxy_pass http://127.0.0.1:3000;
    proxy_http_version 1.1;

    # Auth callback URL is built from these
    proxy_set_header Host              $host;
    proxy_set_header X-Forwarded-Host  $host;
    proxy_set_header X-Forwarded-Proto $scheme;

    # Client address, for rate limiting, the audit log and metrics access
    proxy_set_header X-Forwarded-For   $remote_addr;

    # Websockets: real-time collaboration (/_collab)
    proxy_set_header Upgrade    $http_upgrade;
    proxy_set_header Connection $connection_upgrade;
    proxy_read_timeout 3600s;
  }
}