Wiki.js

https://docs.requarks.io
Admin
Wiki.js is an open-source wiki platform with a modern interface that supports multiple editors,...
Tokens:43,223
Snippets:758
Trust Score:8.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Run Wiki.js Server

Source: https://docs.requarks.io/install/macos

Start the Wiki.js server using Node.js. Once running, open your browser to the setup page.

```bash
node server
```

--------------------------------

### Start Wiki.js Containers

Source: https://docs.requarks.io/install/ubuntu

Starts the PostgreSQL database, Wiki.js, and Wiki.js Update Companion Docker containers.

```bash
docker start db
docker start wiki
docker start wiki-update-companion
```

--------------------------------

### Start Wiki.js Development Environment (Docker Generic)

Source: https://docs.requarks.io/dev

These commands are used to start the Wiki.js development environment using Docker Compose. The `docker exec` commands are necessary for initial setup and running the development server.

```bash
docker-compose -f dev/containers/docker-compose.yml up -d
docker exec wiki-app yarn   # only necessary the first time
docker exec wiki-app yarn dev
```

--------------------------------

### Install Wiki.js with Helm using --set

Source: https://docs.requarks.io/install/kubernetes

Install Wiki.js using Helm, overriding default values with the --set argument. This example disables PostgreSQL persistence.

```bash
helm install --name my-release \
  --set postgresql.persistence.enabled=false \
    requarks/wiki
```

--------------------------------

### Install Wiki.js with Helm using a values.yaml file

Source: https://docs.requarks.io/install/kubernetes

Install Wiki.js using Helm, providing custom configurations via a values.yaml file.

```bash
helm install --name my-release -f values.yaml requarks/wiki
```

--------------------------------

### Start Wiki.js Service

Source: https://docs.requarks.io/install/linux

Start the Wiki.js service using systemctl. This command initiates the background process for Wiki.js.

```bash
systemctl start wiki
```

--------------------------------

### Install Wiki.js Project Dependencies (Manual)

Source: https://docs.requarks.io/dev

Run this command from the project folder after cloning the repository and renaming the configuration file. It installs all necessary Node.js dependencies.

```bash
yarn
```

--------------------------------

### Enable Wiki.js on Boot

Source: https://docs.requarks.io/install/linux

Configure systemd to automatically start the Wiki.js service when the system boots up.

```bash
systemctl enable wiki
```

--------------------------------

### Setup Wiki.js Docker Containers

Source: https://docs.requarks.io/install/ubuntu

Creates necessary directories, secrets, networks, and volumes, then defines and creates the Docker containers for Wiki.js, PostgreSQL, and the update companion.

```bash
# Create installation directory for Wiki.js
mkdir -p /etc/wiki

# Generate DB secret
openssl rand -base64 32 > /etc/wiki/.db-secret

# Create internal docker network
docker network create wikinet

# Create data volume for PostgreSQL
docker volume create pgdata

# Create the containers
docker create --name=db -e POSTGRES_DB=wiki -e POSTGRES_USER=wiki -e POSTGRES_PASSWORD_FILE=/etc/wiki/.db-secret -v /etc/wiki/.db-secret:/etc/wiki/.db-secret:ro -v pgdata:/var/lib/postgresql/data --restart=unless-stopped -h db --network=wikinet postgres:17
docker create --name=wiki -e DB_TYPE=postgres -e DB_HOST=db -e DB_PORT=5432 -e DB_PASS_FILE=/etc/wiki/.db-secret -v /etc/wiki/.db-secret:/etc/wiki/.db-secret:ro -e DB_USER=wiki -e DB_NAME=wiki -e UPGRADE_COMPANION=1 --restart=unless-stopped -h wiki --network=wikinet -p 80:3000 -p 443:3443 ghcr.io/requarks/wiki:2
docker create --name=wiki-update-companion -v /var/run/docker.sock:/var/run/docker.sock:ro --restart=unless-stopped -h wiki-update-companion --network=wikinet ghcr.io/requarks/wiki-update-companion:latest
```

--------------------------------

### Start Wiki Container

Source: https://docs.requarks.io/install/digitalocean

Start the Wiki.js Docker container after it has been created. This command initiates the Wiki.js service and any associated processes.

```bash
docker start wiki
```

--------------------------------

### Extract Wiki.js and Set Up Directory

Source: https://docs.requarks.io/install/windows

Creates a directory for Wiki.js and extracts the downloaded archive. Navigates to the installation directory.

```powershell
New-Item -Path "C:\" -Name "wiki" -ItemType "directory"
tar xzf wiki-js.tar.gz -C "C:\wiki"
cd C:\wiki
```

--------------------------------

### Install Docker on Ubuntu (24.04+)

Source: https://docs.requarks.io/install/ubuntu

Installs Docker CE, CLI, containerd.io, and buildx plugin using the official Docker repository for newer Ubuntu versions.

```bash
# Add Docker's official GPG key:
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add the repository to Apt sources:
sudo tee /etc/apt/sources.list.d/docker.sources <<EOF
Types: deb
URIs: https://download.docker.com/linux/ubuntu
Suites: $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}")
Components: stable
Signed-By: /etc/apt/keyrings/docker.asc
EOF

# Install Docker
sudo apt -qqy update
sudo apt -qqy install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
```

--------------------------------

### Launch Wiki.js with Docker Compose

Source: https://docs.requarks.io/install/docker-desktop

Execute this command in the terminal within your Wiki.js installation directory to start the services defined in your docker-compose.yaml file in detached mode.

```bash
docker compose up -d
```

--------------------------------

### Install Docker on Ubuntu (18.04-22.04)

Source: https://docs.requarks.io/install/ubuntu

Installs Docker CE, CLI, containerd.io, and compose plugin using the official Docker repository for older Ubuntu versions.

```bash
# Install dependencies to install Docker
sudo apt -qqy -o Dpkg::Options::='--force-confdef' -o Dpkg::Options::='--force-confold' install ca-certificates curl gnupg lsb-release

# Register Docker package registry
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

# Refresh package udpates and install Docker
sudo apt -qqy update
sudo apt -qqy -o Dpkg::Options::='--force-confdef' -o Dpkg::Options::='--force-confold' install docker-ce docker-ce-cli containerd.io docker-compose-plugin
```

--------------------------------

### Run Wiki.js with Let's Encrypt

Source: https://docs.requarks.io/install/docker

This command starts a Wiki.js container with automated Let's Encrypt SSL certificate provisioning. It maps HTTP port 80 and HTTPS port 3443, configures the domain and email for Let's Encrypt, and sets up a PostgreSQL database connection. Assumes a database container named 'db' is available on the same network.

```docker
docker run -d -p 80:3000 -p 443:3443 -e "LETSENCRYPT_DOMAIN=wiki.example.com" -e "LETSENCRYPT_EMAIL=admin@example.com" --name wiki --restart unless-stopped -e "DB_TYPE=postgres" -e "DB_HOST=db" -e "DB_PORT=5432" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" ghcr.io/requarks/wiki:2
```

--------------------------------

### Install Local Module Dependency

Source: https://docs.requarks.io/dev/modules

After initializing a local package.json, install necessary npm dependencies directly into your module's directory. This ensures dependencies are isolated and do not conflict with the core Wiki.js installation.

```bash
npm install your-dependency
```

--------------------------------

### Install Wiki.js Chart with Helm 2

Source: https://docs.requarks.io/install/kubernetes

Install the Wiki.js chart using Helm 2 with a specified release name. This deploys Wiki.js with default configurations.

```bash
helm install --name my-release requarks/wiki
```

--------------------------------

### Install Wiki.js Chart with Helm 3

Source: https://docs.requarks.io/install/kubernetes

Install the Wiki.js chart using Helm 3 with a specified release name. This deploys Wiki.js with default configurations.

```bash
helm install my-release requarks/wiki
```

--------------------------------

### Wiki.js systemd Service Configuration

Source: https://docs.requarks.io/install/linux

Paste this content into the 'wiki.service' file. It defines how systemd should manage the Wiki.js process, assuming installation at '/var/wiki'.

```ini
[Unit]
Description=Wiki.js
After=network.target

[Service]
Type=simple
ExecStart=/usr/bin/node server
Restart=always
# Consider creating a dedicated user for Wiki.js here:
User=nobody
Environment=NODE_ENV=production
WorkingDirectory=/var/wiki

[Install]
WantedBy=multi-user.target
```

--------------------------------

### Configure External PostgreSQL Server

Source: https://docs.requarks.io/install/kubernetes

Configure Wiki.js to use an external PostgreSQL server by setting `postgresql.enabled` to false and providing connection details. This example shows how to specify host, port, database, username, and an existing Kubernetes Secret for the password.

```yaml
externalPostgresql:
  host: your-db-host.example.com
  port: 5432
  database: wikijs
  username: wikijsuser
  existingSecret: wikijs-db-secret  # Kubernetes Secret containing password
  existingSecretKey: password        # Key in the Secret containing the DB password
  ssl: false                         # Enable SSL if needed
  ca: /path/to/ca.pem                # Optional CA path for SSL
```

--------------------------------

### Define Module Properties

Source: https://docs.requarks.io/dev/module-properties

Example demonstrating various module property definitions, including type, default values, titles, hints, enum lists, and multiline support.

```yaml
props:
    exampleProperty: String
    anotherProperty: Number
    propertyWithDefault:
        type: Boolean
        default: true
    propertyWithTitleHint:
        type: String
        default: 'abc'
        title: 'Property Title'
        hint: 'An explanation of the field.'
    propertyWithEnumList:
        type: String
        default: 'first'
        enum:
            - 'first'
            - 'second'
            - 'third'
    propertyWithMultiline:
        type: String
        multiline: true
```

--------------------------------

### Backup Wiki.js Database

Source: https://docs.requarks.io/install/transfer

Use this command on the old server to create a full PostgreSQL database dump for Wiki.js. Ensure the container name and database details match your setup.

```bash
docker exec db pg_dump wiki -U wiki -F c > wikibackup.dump
```

--------------------------------

### Upgrade Wiki.js on Windows (Standalone)

Source: https://docs.requarks.io/install/upgrade

Upgrade a standalone Wiki.js installation on Windows by backing up configuration, clearing the application folder, downloading the new version, and restarting the server. This process requires PowerShell and assumes installation at 'C:\wiki'. Note the TLS 1.2 setting for older Windows versions.

```powershell
Copy-Item "C:\wiki\config.yml" -Destination "C:\config.yml.bak"
```

```powershell
Clear-Content "C:\wiki\*"
```

```powershell
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12
```

```powershell
Invoke-WebRequest -Uri "https://github.com/Requarks/wiki/releases/latest/download/wiki-js-windows.tar.gz" -OutFile "wiki-js.tar.gz"
```

```powershell
tar xzf wiki-js.tar.gz -C "C:\wiki"
cd C:\wiki
```

```powershell
Copy-Item "C:\config.yml.bak" -Destination "C:\wiki\config.yml"
```

```powershell
node server
```

--------------------------------

### Upgrade Wiki.js on Linux/macOS (Standalone)

Source: https://docs.requarks.io/install/upgrade

Upgrade a standalone Wiki.js installation on Linux or macOS by backing up configuration, removing the old application, downloading the new version, and restarting the server. This process assumes installation in a subfolder named 'wiki'.

```bash
cp wiki/config.yml ~/config.yml.bak
```

```bash
rm -rf wiki/*
```

```bash
wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz
```

```bash
tar xzf wiki-js.tar.gz -C ./wiki
cd wiki
```

```bash
cp ~/config.yml.bak ./config.yml
```

```bash
node server
```

--------------------------------

### Run Wiki.js with MySQL

Source: https://docs.requarks.io/install/docker

This command starts a Wiki.js container in detached mode, maps port 8080 to 3000, sets restart policy, and configures a MySQL database connection. Assumes a database container named 'db' is available on the same network.

```docker
docker run -d -p 8080:3000 --name wiki --restart unless-stopped -e "DB_TYPE=mysql" -e "DB_HOST=db" -e "DB_PORT=3306" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" ghcr.io/requarks/wiki:2
```

--------------------------------

### Run Wiki.js with PostgreSQL

Source: https://docs.requarks.io/install/docker

This command starts a Wiki.js container in detached mode, maps port 8080 to 3000, sets restart policy, and configures a PostgreSQL database connection. Assumes a database container named 'db' is available on the same network.

```docker
docker run -d -p 8080:3000 --name wiki --restart unless-stopped -e "DB_TYPE=postgres" -e "DB_HOST=db" -e "DB_PORT=5432" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" ghcr.io/requarks/wiki:2
```

--------------------------------

### Example Storage Module Definition

Source: https://docs.requarks.io/dev/storage

Defines the metadata for a storage module, including its key, title, author, supported modes, and user-configurable properties.

```yaml
key: example
title: Example Storage
description: A short description about Example Storage
author: John Doe
logo: https://../example.svg
website: https://www.example.com/
isAvailable: true
supportedModes:
    - push
defaultMode: push
schedule: false
props:
  firstExampleProperty: String
  secondExampleProperty: Number
actions:
    - handler: firstAction
      label: First Action Example
      hint: Description of what this action does

```

--------------------------------

### Activated Event Handler

Source: https://docs.requarks.io/dev/storage

Implement this method to perform checks and setup when the storage module is activated. Access configuration using `this.config`. Errors thrown here will prevent activation.

```javascript
async activated () { }

```

--------------------------------

### Enable High-Availability Mode

Source: https://docs.requarks.io/install/config

Set to `true` if running multiple concurrent instances of Wiki.js with a shared PostgreSQL database. Requires PostgreSQL and a single initial instance setup.

```yaml
ha: true
```

--------------------------------

### Rename Configuration File

Source: https://docs.requarks.io/install/macos

Rename the sample configuration file to 'config.yml' to begin customizing your Wiki.js installation.

```bash
mv config.sample.yml config.yml
```

--------------------------------

### Example GraphQL Success Response

Source: https://docs.requarks.io/dev/api

An example of a successful response from a GraphQL mutation, including the responseResult object.

```json
{
  "responseResult": {
    "succeeded": true
    "errorCode": 0
    "slug": "success",
    "message": "The operation completed successfully"
  }
}
```

--------------------------------

### Configure MS SQL Server Database

Source: https://docs.requarks.io/install/config

Set up connection details for a MS SQL Server database. The database must exist, and Wiki.js will not create it.

```yaml
db:
  type: mssql
  host: localhost
  port: 1433
  user: wikijs
  pass: wikijsrocks
  db: wiki
```

--------------------------------

### Edit Configuration File

Source: https://docs.requarks.io/install/macos

Open the 'config.yml' file using nano to set up your database and port configurations. Refer to the Configuration Reference for details.

```bash
nano config.yml
```

--------------------------------

### Configure PostgreSQL Database

Source: https://docs.requarks.io/install/config

Set up connection details for a PostgreSQL database. The database must exist, and Wiki.js will not create it. SSL connections are handled separately.

```yaml
db:
  type: postgres
  host: localhost
  port: 5432
  user: wikijs
  pass: wikijsrocks
  db: wiki
```

--------------------------------

### Configure MySQL Database

Source: https://docs.requarks.io/install/config

Set up connection details for a MySQL database. The database must exist, and Wiki.js will not create it. SSL connections are handled separately.

```yaml
db:
  type: mysql
  host: localhost
  port: 3306
  user: wikijs
  pass: wikijsrocks
  db: wiki
```

--------------------------------

### Configure MariaDB Database

Source: https://docs.requarks.io/install/config

Set up connection details for a MariaDB database. The database must exist, and Wiki.js will not create it. SSL connections are handled separately.

```yaml
db:
  type: mariadb
  host: localhost
  port: 3306
  user: wikijs
  pass: wikijsrocks
  db: wiki
```

--------------------------------

### Create systemd Service File

Source: https://docs.requarks.io/install/linux

Create a new systemd service file for Wiki.js in the '/etc/systemd/system' directory. This is for running Wiki.js as a background service.

```bash
nano /etc/systemd/system/wiki.service
```

--------------------------------

### Update Ubuntu Machine

Source: https://docs.requarks.io/install/ubuntu

Ensures your system has the latest package information and all installed packages are up-to-date.

```bash
# Fetch latest updates
sudo apt -qqy update

# Install all updates automatically
sudo DEBIAN_FRONTEND=noninteractive apt-get -qqy -o Dpkg::Options::='--force-confdef' -o Dpkg::Options::='--force-confold' dist-upgrade
```

--------------------------------

### Build Multi-Architecture Docker Images (ARM)

Source: https://docs.requarks.io/dev

Build multi-architecture images for arm64 and arm/v7 using Docker's buildx plugin and QEMU. Ensure the buildx plugin is enabled.

```bash
docker buildx build --platform linux/arm64,linux/arm/v7 -t requarks/wiki:arm --push -f dev/build/Dockerfile .
```

--------------------------------

### Initialize Storage Strategy

Source: https://docs.requarks.io/dev/storage

The `init` event is triggered upon Wiki.js initialization or restart, and after the `activated` event. It's useful for establishing connections in storage strategies.

```javascript
async init () { }
```

--------------------------------

### Build Wiki.js Project for Deployment

Source: https://docs.requarks.io/dev/themes

Run this command to compile your Wiki.js project, including your custom theme, for production deployment. This generates necessary assets and views.

```bash
yarn build
```

--------------------------------

### init

Source: https://docs.requarks.io/dev/storage

Called upon initialization of Wiki.js (both startups or restarts) and directly after the `activated` event. This is useful to establish a connection in some storage strategies. Any error thrown will prevent the storage strategy from being used until Wiki.js is restarted or the error is acknowledged.

```APIDOC
## init

### Description
Called upon initialization of Wiki.js (both startups or restarts) and directly after the `activated` event. This is useful to establish a connection in some storage strategies.

### Method
`async init ()`

### Parameters
This method does not accept any parameters.

### Context
`this.config`: Object containing the configuration of the storage strategy.

### Error Handling
Any error thrown (or returning a rejected promise) will prevent the storage strategy from being used until Wiki.js is restarted or the error is acknowledged by the user in the administration area.
```

--------------------------------

### Download Wiki.js Archive

Source: https://docs.requarks.io/install/macos

Use wget to download the latest release of Wiki.js. Ensure you have wget installed or use an alternative download method.

```bash
wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz
```

--------------------------------

### Initialize Local Package.json

Source: https://docs.requarks.io/dev/modules

Create a local package.json file within your module directory to manage its specific dependencies. Accept default values during initialization.

```bash
npm init
```

--------------------------------

### Enable Offline Mode

Source: https://docs.requarks.io/install/config

Set to `true` to prevent Wiki.js from attempting to download file updates, useful for installations without internet access. This also enables sideloading.

```yaml
offline: true
```

--------------------------------

### Build Production Docker Image

Source: https://docs.requarks.io/dev

Use this command to build the standard production Docker image for Wiki.js.

```bash
docker build -t requarks/wiki -f dev/build/Dockerfile .
```

--------------------------------

### Create Links

Source: https://docs.requarks.io/editors/markdown

Use square brackets for link text and parentheses for the target URL or path.

```markdown
[Lorem ipsum](https://wiki.js.org/about)

Consectetur [adipiscing](/install/requirements) elit
```

--------------------------------

### Fix Node.js Port Binding Issues on Linux

Source: https://docs.requarks.io/troubleshooting

Use setcap to grant Node.js privileges for binding to low ports (< 1024) on Ubuntu/Debian. Ensure Node.js is installed correctly.

```bash
# Ubuntu / Debian

sudo apt-get install libcap2-bin
sudo setcap cap_net_bind_service=+ep `readlink -f 
which node
`
```

--------------------------------

### Specify Bind IP Address

Source: https://docs.requarks.io/install/config

Configure the IP address Wiki.js should listen on. `0.0.0.0` listens on all available network interfaces.

```yaml
bindIP: 0.0.0.0
```

--------------------------------

### Interpolate Environment Variables in config.yml

Source: https://docs.requarks.io/install/config

Use $(ENV_NAME) syntax within your config.yml to dynamically set values from environment variables at runtime. Ensure environment variables are correctly set before the application starts.

```yaml
db:
  type: $(DB_TYPE)
  host: '$(DB_HOST)'
  port: $(DB_PORT)
  user: '$(DB_USER)'
  pass: '$(DB_PASS)'
```

```yaml
db:
  type: postgres
  host: 'db.example.com'
  port: 5432
  user: 'wiki'
  pass: 'secret'
```

--------------------------------

### Docker Compose Configuration for Wiki.js with PostgreSQL

Source: https://docs.requarks.io/install/docker

A complete Docker Compose file to set up Wiki.js with a PostgreSQL database. Ensure the DB_HOST environment variable matches the service name defined in the compose file.

```yaml
services:

  db:
    image: postgres:15-alpine
    environment:
      POSTGRES_DB: wiki
      POSTGRES_PASSWORD: wikijsrocks
      POSTGRES_USER: wikijs
    logging:
      driver: none
    restart: unless-stopped
    volumes:
      - db-data:/var/lib/postgresql/data

  wiki:
    image: ghcr.io/requarks/wiki:2
    depends_on:
      - db
    init: true
    environment:
      DB_TYPE: postgres
      DB_HOST: db
      DB_PORT: 5432
      DB_USER: wikijs
      DB_PASS: wikijsrocks
      DB_NAME: wiki
    restart: unless-stopped
    ports:
      - "80:3000"

volumes:
  db-data:
```

--------------------------------

### Create and Push Docker Manifest List

Source: https://docs.requarks.io/dev

Merge multiple architecture-specific Docker images into a single manifest list. The first reference is the final manifest list, followed by the image digests to include.

```bash
docker manifest create requarks/wiki:arm requarks/wiki@sha256:abcdef123456 requarks/wiki@sha256:fedcba654321
docker manifest push -p requarks/wiki:arm
```

--------------------------------

### Enable Let's Encrypt SSL

Source: https://docs.requarks.io/install/config

Configure Wiki.js to automatically obtain and renew SSL certificates using Let's Encrypt. Ensure the domain is correctly pointed to the server and the email is valid.

```yaml
ssl:
  enabled: true
  port: 3443
  provider: letsencrypt

  domain: wiki.yourdomain.com
  subscriberEmail: admin@example.com
```

--------------------------------

### Create Wiki Container with Let's Encrypt

Source: https://docs.requarks.io/install/digitalocean

Create a new Wiki.js Docker container with Let's Encrypt enabled for automatic HTTPS. Ensure you replace placeholder values with your actual domain and administrator email.

```bash
docker create --name=wiki -e LETSENCRYPT_DOMAIN=wiki.example.com -e LETSENCRYPT_EMAIL=admin@example.com -e SSL_ACTIVE=1 -e DB_TYPE=postgres -e DB_HOST=db -e DB_PORT=5432 -e DB_PASS_FILE=/etc/wiki/.db-secret -v /etc/wiki/.db-secret:/etc/wiki/.db-secret:ro -e DB_USER=wiki -e DB_NAME=wiki -e UPGRADE_COMPANION=1 --restart=unless-stopped -h wiki --network=wikinet -p 80:3000 -p 443:3443 requarks/wiki:2
```

--------------------------------

### Edit Configuration File

Source: https://docs.requarks.io/install/windows

Opens the `config.yml` file in Notepad for editing database and port settings.

```powershell
notepad .\config.yml
```

--------------------------------

### Build Docker Image for Wiki.js Theme

Source: https://docs.requarks.io/dev/themes

Use this command to build a Docker image for your Wiki.js instance with your custom theme. Replace 'my-org/wiki:some-tag' with your desired image name and tag.

```bash
docker build -f dev/build/Dockerfile -t my-org/wiki:some-tag .
```

--------------------------------

### Restore Wiki.js Database Dump

Source: https://docs.requarks.io/install/transfer

On the new server, drop and recreate the Wiki.js database, then restore the backup using pg_restore. This command pipes the backup file into the PostgreSQL container.

```bash
docker exec -it db dropdb -U wiki wiki
docker exec -it db createdb -U wiki wiki
cat ~/wikibackup.dump | docker exec -i db pg_restore -U wiki -d wiki
```

--------------------------------

### Extract Wiki.js Package

Source: https://docs.requarks.io/install/macos

Create a directory for Wiki.js, extract the downloaded archive into it, and navigate into the directory.

```bash
mkdir wiki
tar xzf wiki-js.tar.gz -C ./wiki
cd ./wiki
```

--------------------------------

### Rebuild SQLite3 Bindings

Source: https://docs.requarks.io/install/macos

If you are using SQLite as your database, run this command to fetch native bindings for SQLite3. Skip this step if using a different database.

```bash
npm rebuild sqlite3
```

--------------------------------

### Create a Basic Unordered List

Source: https://docs.requarks.io/editors/markdown

Use asterisks or dashes followed by a space to create bullet points in an unordered list.

```markdown
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Morbi vehicula aliquam
```

--------------------------------

### Implement Search Engine Module Methods

Source: https://docs.requarks.io/dev/search

The engine.js file contains methods for module activation, deactivation, initialization, search queries, suggestions, and content lifecycle events (created, updated, deleted, renamed, rebuild).

```javascript
module.exports = {
  async activated () {

  },
  async deactivated () {

  },
  async init () {

  },
  async suggest (q, opts) {

  },
  async query (q, opts) {

  },
  async created (page) {

  },
  async updated (page) {

  },
  async deleted (page) {

  },
  async renamed (page) {

  },
  async rebuild () {

  }
}
```

--------------------------------

### Configure Custom SSL Certificate (PFX)

Source: https://docs.requarks.io/install/config

Enable HTTPS with a custom certificate in PFX format. Specify the path to the PFX file and its passphrase if encrypted. The HTTPS port cannot be the same as the HTTP port.

```yaml
ssl:
  enabled: true
  port: 3443
  provider: custom

  format: pfx
  pfx: path/to/cert.pfx
  passphrase: null
  dhparam: null
```
Tokens:
Raw