docs.benjamin-altpeter.de

Wiki.js

Installed at 10.1.1.17. Only available privately.

The application runs in an Ubuntu 20.04 unprivileged LXC container. Under Options, enable the Nesting feature for Docker to work.

Setup #

The setup is based on the official install documentation, we are using the Docker installation method.

apt install apt-transport-https ca-certificates curl gnupg-agent software-properties-common openssl

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add -
add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
apt update
apt install docker-ce docker-ce-cli containerd.io

mkdir -p /etc/wiki
openssl rand -base64 32 > /etc/wiki/.db-secret

docker network create wikinet
docker volume create pgdata
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:11
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 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 requarks/wiki-update-companion:latest

docker start db
docker start wiki
docker start wiki-update-companion

Visit http://10.1.1.17 in the browser and complete the setup wizard.

Git synchronization #

See the docs for reference.

  • Create an SSH key: ssh-keygen -t rsa -b 4096
  • In the GitLab repo, go to Settings, Repository and Deploy Keys and add the key. Allow write access.
  • In the Wiki.js admin area, go to Storage and Git. Activate the storage target, the settings are self-explanatory.
  • At the very bottom of the page, click Run under Import everything.

Email config #

In the admin area, go to Mail. Setup email credentials for sending mail.

Search config #

In the admin area, go into Search engine and select Database - PostgreSQL. Click the Rebuild Index button.

Updates #

Subscribe to the releases on GitHub.

TODO: https://docs.requarks.io/install/ubuntu#upgrade