---
title: "Deploy Wiki.js on Pethost in one click"
description: "A wiki for a team or a project: pages in Markdown or a visual editor, search, permissions and sign-in providers. A template for Pethost: in a minute or two the app is live on your machine, with HTTPS at its own address and nightly backups."
---

[← All templates](https://pethost.dev/templates/)

# Deploy Wiki.js on Pethost in one click

A wiki for a team or a project: pages in Markdown or a visual editor, search, permissions and sign-in providers

[Deploy on Pethost](https://console.pethost.dev/?template=wiki-js)

## What happens

1. You sign in to Pethost or make an account, with a passkey, GitHub or Google.
2. No machine yet? You pick a plan, and we prepare one for you. The link waits in your browser until it is ready.
3. New project opens at the app. You fill in what it asks for and click Create project: **Email**, **Admin password**.
4. In a minute or two the app is live at its own address with HTTPS. Its secrets are made for it at random, and its data is in the nightly backup.
5. It is a project like any other: its compose.yaml, its .env, its logs and a terminal are in the panel, and your agent can change it, roll it back or restore it.

## First steps

Sign in with the email and the admin password you gave: Wiki.js is set up with them before it answers, so nobody else gets its setup page. Pages are created from the home page; users, groups and sign-in providers are under Administration.

## What it runs

The template is this compose.yaml and the variables it writes into the project’s .env. Pethost runs the file as it is written.

```
services:
  wiki:
    image: ghcr.io/requarks/wiki:2.5.315
    restart: unless-stopped
    environment:
      DB_TYPE: postgres
      DB_HOST: postgres
      DB_PORT: "5432"
      DB_USER: wiki
      DB_PASS: ${POSTGRES_PASSWORD}
      DB_NAME: wiki
      SITE_URL: ${URL}
      ADMIN_EMAIL: ${ADMIN_EMAIL}
      ADMIN_PASSWORD: ${ADMIN_PASSWORD}
    # Wiki.js opens its setup page to whoever comes first. On the first start it runs once on
    # port 3001, which nobody reaches, is set up there with the email and password given, and only
    # then starts on 3000.
    entrypoint: ["/bin/sh", "-c"]
    command:
      - |
        installed=$$(node -e "
          const { Client } = require('pg');
          const db = new Client({ host: 'postgres', user: process.env.DB_USER, password: process.env.DB_PASS, database: process.env.DB_NAME });
          db.connect().then(() => db.query('select count(*) from settings')).then((r) => console.log(r.rows[0].count > 0 ? 'yes' : 'no'), () => console.log('no')).then(() => process.exit(0));
        ")
        if [ "$$installed" = no ]; then
          sed 's/^port: 3000/port: 3001/' config.yml > /tmp/setup.yml
          CONFIG_FILE=/tmp/setup.yml node server &
          setup=$$!
          node -e "
            const body = JSON.stringify({ adminEmail: process.env.ADMIN_EMAIL, adminPassword: process.env.ADMIN_PASSWORD, adminPasswordConfirm: process.env.ADMIN_PASSWORD, siteUrl: process.env.SITE_URL, telemetry: false });
            (async () => {
              for (let i = 0; i < 180; i++) {
                try {
                  const answer = await fetch('http://127.0.0.1:3001/finalize', { method: 'POST', headers: { 'content-type': 'application/json' }, body });
                  console.log('setup:', await answer.text());
                  return;
                } catch { await new Promise((done) => setTimeout(done, 1000)); }
              }
            })();
          "
          sleep 3
          kill $$setup
          wait $$setup
        fi
        exec node server
    volumes:
      - content:/wiki/data/content
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      POSTGRES_DB: wiki
      POSTGRES_USER: wiki
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
    volumes:
      - db:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -h 127.0.0.1 -U wiki -d wiki"]
      interval: 5s
      timeout: 5s
      retries: 10
      start_period: 30s

volumes:
  content:
  db:
```

[compose.yaml](https://pethost.dev/templates/wiki-js/compose.yaml)[See it on GitHub](https://github.com/pethost-dev/templates/tree/main/wiki-js)

Pethost · Stephan Gomer · NIP 1133096755

[Templates](https://pethost.dev/templates/) [About](https://pethost.dev/about/) [Blog](https://pethost.dev/blog/) [Terms](https://pethost.dev/terms/) [Privacy](https://pethost.dev/privacy/) [Refunds](https://pethost.dev/refunds/) [API](https://pethost.dev/docs/api/) [CLI](https://pethost.dev/docs/cli/) [Plugin](https://github.com/pethost-dev/plugin) [support@pethost.dev](mailto:support@pethost.dev)