This is an NS8 application for Bookstack, a free and open source Wiki designed for teams.

Instantiate the module with:

add-module ghcr.io/geniusdynamics/bookstack:latest 1

The output of the command will return the instance name. Output example:

{"module_id": "bookstack1", "image_name": "bookstack", "image_url": "ghcr.io/geniusdynamics/bookstack:latest"}

Initial Login Credentials for Bookstack

• Username: admin@admin.com
• Password: password

Let's assume that the bookstack instance is named bookstack1.

Launch configure-module, by setting the following parameters:

• host: a fully qualified domain name for the application
• http2https: enable or disable HTTP to HTTPS redirection (true/false)
• lets_encrypt: enable or disable Let's Encrypt certificate (true/false)

Example:

api-cli run configure-module --agent module/bookstack1 --data - <<EOF
{
  "host": "bookstack.domain.com",
  "http2https": true,
  "lets_encrypt": false
}
EOF

The above command will:

• start and configure the bookstack instance
• configure a virtual host for Traefik to access the instance

You can retrieve the configuration with

api-cli run get-configuration --agent module/bookstack1

api-cli run update-module --data '{
  "module_url": "ghcr.io/geniusdynamics/bookstack:latest",
  "instances": ["bookstack1"],
  "force": true
}'

To uninstall the instance:

remove-module --no-preserve bookstack1

Some configuration settings, like the smarthost setup, are not part of the configure-module action input: they are discovered by looking at some Redis keys. To ensure the module is always up-to-date with the centralized smarthost setup every time bookstack starts, the command bin/discover-smarthost runs and refreshes the state/smarthost.env file with fresh values from Redis.

Furthermore if smarthost setup is changed when bookstack is already running, the event handler events/smarthost-changed/10reload_services restarts the main module service.

See also the systemd/user/bookstack.service file.

This setting discovery is just an example to understand how the module is expected to work: it can be rewritten or discarded completely.

Some CLI commands are needed to debug the module:

• The module runs under an agent that initiates a lot of environment variables (in /home/bookstack1/.config/state), it could be useful to verify them on the root terminal:

  `runagent -m bookstack1 env`
  

• You can become runagent for testing scripts and initiate all environment variables:

  runagent -m bookstack1

The path becomes:

    echo $PATH
    /home/bookstack1/.config/bin:/usr/local/agent/pyenv/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/usr/

• If you want to debug a container or see environment inside:

  runagent -m bookstack1

Then you can run:

podman ps
CONTAINER ID  IMAGE                                      COMMAND               CREATED        STATUS        PORTS                    NAMES
d292c6ff28e9  localhost/podman-pause:4.6.1-1702418000                          9 minutes ago  Up 9 minutes  127.0.0.1:20015->80/tcp  80b8de25945f-infra
d8df02bf6f4a  docker.io/library/mariadb:10.11.5          --character-set-s...  9 minutes ago  Up 9 minutes  127.0.0.1:20015->80/tcp  mariadb-app
9e58e5bd676f  docker.io/library/nginx:stable-alpine3.17  nginx -g daemon o...  9 minutes ago  Up 9 minutes  127.0.0.1:20015->80/tcp  bookstack-app

You can see what environment variables are inside the container:

podman exec bookstack-app env
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
TERM=xterm
PKG_RELEASE=1
MARIADB_DB_HOST=127.0.0.1
MARIADB_DB_NAME=bookstack
MARIADB_IMAGE=docker.io/mariadb:10.11.5
MARIADB_DB_TYPE=mysql
container=podman
NGINX_VERSION=1.24.0
NJS_VERSION=0.7.12
MARIADB_DB_USER=bookstack
MARIADB_DB_PASSWORD=bookstack
MARIADB_DB_PORT=3306
HOME=/root

You can run a shell inside the container:

podman exec -ti bookstack-app sh
/ #

Test the module using the test-module.sh script:

./test-module.sh <NODE_ADDR> ghcr.io/geniusdynamics/bookstack:latest

The tests are made using Robot Framework

Translated with Weblate.

To setup the translation process:

• add GitHub Weblate app to your repository
• add your repository to hosted.weblate.org or ask a NethServer developer to add it to the ns8 Weblate project