> ## Documentation Index
> Fetch the complete documentation index at: https://docs.springwinter.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Deploy Wiki.js

> Set up Wiki.js with Spring Winter and verify the deployment.

## Deploy with an agent

Copy agent prompt

Help me deploy Wiki.js with Spring Winter. Start with the tested configuration at [https://docs.springwinter.dev/deploy/open-source/wiki-js](https://docs.springwinter.dev/deploy/open-source/wiki-js.md) and read [https://docs.springwinter.dev/api-reference/agents](https://docs.springwinter.dev/api-reference/agents.md). Fetch the current public OpenAPI document from my Spring Winter origin. Use my local SPRINGWINTER\_TOKEN or existing SPRINGWINTER\_API\_TOKEN. Keep credentials out of chat, logs and source.

Ask whether I want the v2 recipe on this page or the separately tested Wiki.js 3.4.0 deployment. For v3, read [https://docs.js.wiki/setup/installation](https://docs.js.wiki/setup/installation). Use PostgreSQL 17 or later, port 3000, /\_ready, and ADMIN\_EMAIL and ADMIN\_PASS for first-run setup. Apply the v2 image and /healthz instructions below only if I choose v2. Keep the first-admin setup restricted until the intended administrator has claimed it.

Confirm my organization, AWS connection, project, Region and budget. Show me the deployment plan and ask for approval before making changes. Include any planned restart, task replacement or restore in that approval. Check the regional catalog for the tested RDS PostgreSQL 18.3 configuration. If the catalog has changed, explain the difference before provisioning.

After approval, create the private PostgreSQL database first and wait for the writer. Configure the DB connection using its writer endpoint and credentials. Set DB\_SSL=true and set DB\_SSL\_CA to the base64 body of the single AWS RDS root certificate that matches the database Region and CA identifier.

For v2, deploy Wiki.js 2.5.317 using ghcr.io/requarks/wiki\@sha256:1c7b37a0171577903883c50ffc8fcff98f6de323c80fb629061a4e06562dcf1d. Keep the default startup command. Use port 3000, health path /healthz, one task, 0.5 vCPU and 1 GiB RAM. For v3, use the pinned upstream 3.4.0 image and its documented startup command. Start with one task. Wait for the workflow and verify the selected version’s first-run administrator setup over HTTPS. After setup, check the selected version’s health endpoint and verify that a test page survives task replacement. Check assets separately when the plan includes durable asset storage. Report what you verified and anything still pending.

## Create the database

1. [Connect your AWS account](https://docs.springwinter.dev/connect-aws.md) and select a project. Create a private [SQL database](https://docs.springwinter.dev/deploy/databases.md) in the same project as the web server.
2. The tested setup used `us-east-1`, single-AZ Amazon RDS PostgreSQL `18.3`, `db.t4g.micro`, 20 GiB of gp3 storage and seven days of automated backups. Use the regional catalog to check availability. Create an empty database named `wiki` with a dedicated database user.
3. Wait for the database workflow to succeed. Open **Connect** and use the private writer endpoint and its credentials.

## Deploy the web server

Create a [web server](https://docs.springwinter.dev/deploy/web-servers.md) with these settings.

| Setting | Tested value |
| - | - |
| Wiki.js release | 2.5.317 |
| Public image | `ghcr.io/requarks/wiki@sha256:1c7b37a0171577903883c50ffc8fcff98f6de323c80fb629061a4e06562dcf1d` |
| Startup command | Leave blank to use the image default, `node --no-deprecation server` |
| Container port | `3000` |
| Health path | `/healthz` |
| Task size | 0.5 vCPU and 1 GiB RAM |
| Minimum and maximum copies | 1 and 1 |
| Task volume | Leave unset. Pages and uploaded assets are stored in PostgreSQL. |

Set these [runtime variables](https://docs.springwinter.dev/concepts/environment-variables.md) before you deploy.

| Variable | Value |
| - | - |
| `DB_TYPE` | `postgres` |
| `DB_HOST` | Private RDS writer hostname from **Connect** |
| `DB_PORT` | Writer port, `5432` in the tested setup |
| `DB_NAME` | `wiki` |
| `DB_USER` | Database username from **Connect** |
| `DB_PASS` | Database password from **Connect** |
| `DB_SSL` | `true` |
| `DB_SSL_CA` | Base64 body of the matching RDS root certificate, on one line |

The tested deployment used the **Amazon RDS us-east-1 Root CA RSA2048 G1**. Check your database’s CA identifier in the RDS console and select the matching root from the bundle for your Region. For `DB_SSL_CA`, remove the PEM header, footer and line breaks from that single certificate. [AWS RDS certificate bundles](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) · [Wiki.js TLS implementation](https://github.com/requarks/wiki-v2/blob/v2.5.317/server/core/db.js)

## Complete setup and verify

1. Wait for the web deployment to succeed in **History**. Open the managed HTTPS URL, create the first administrator and set the site URL to that HTTPS address. Wiki.js handles its schema initialization.
2. Before setup completes, `/healthz` can return the setup page with HTTP 200. After setup, check that it returns HTTP 200 with `{"ok":true}`.
3. Create and edit a test page. Upload a sample asset. Replace the web task and confirm that the page and asset still load.

[Wiki.js Docker instructions](https://docs.requarks.io/install/docker) · [Published image](https://github.com/Requarks/wiki/pkgs/container/wiki/1437695784?tag=2.5.317)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.