Configuration

The Installation Guide can be found here.

An Otter Wiki is configured in the application via the Settings interface as admin user. Alternatively you configure the variables via the settings.cfg or via environment variables.

Please note: What is set in the config file settings.cfg will be overwritten first by the environment variables if they are set and second by the settings configured via the settings interface, which are stored in the database. In brief: Settings Interface > Environment Variables > settings.cfg.

Branding

Permission configuration

There are four types of users in the Otterwiki: ANONYMOUS are non logged in users. Users that registered via email and are logged in are REGISTERED, users approved via the settings menu by an admin are APPROVED. In addition to the APPROVED flag the ADMIN flag can be set. Users with the ADMIN flag can edit (and approve) other users. The first registered user is flagged as admin.

Sidebar Preferences

For SIDEBAR_MENUTREE_MODE pick one of

• NONE (or empty) no sidebar displayed
• SORTED Directories and pages, sorted
• DIRECTORIES_GROUPED Directories and pages, with directories grouped first
• DIRECTORIES_ONLYList directories only.

Content and Editing Preferences

Mail configuration

An Otter Wiki is using Flask-Mail.

Authentication configuration

Per default an Otter Wiki uses a local database for storing authentication information.

Authentication with PROXY_HEADERs

With AUTH_METHOD='PROXY_HEADER' an Otter Wiki expects the headers

• x-otterwiki-name
• x-otterwiki-email
• x-otterwiki-permissions

to be set by the proxy service using forward authentication.

The headers x-otterwiki-nameand x-otterwiki-email are used for receiving author information and x-otterwiki-permissions a comma seperated list of permissions READ, WRITE, UPLOAD and ADMIN.

A simplified proof of concept can be found on github: otterwiki/docs/auth_examples/header-auth.

Advanced configuration

This applies only when you create the settings.cfg manually. Create your settings.cfg based upon the settings.cfg.skeleton and set the variables fitting to your environment.

For the SQLALCHEMY_DATABASE_URI see https://flask-sqlalchemy.palletsprojects.com/en/2.x/config/#connection-uri-format.

User UID running docker process

Per default in both the default and the -slim image the process running An Otter Wiki (and accessing the files in repository) is running with uid=33.

UID in the default image

To change this when using the default image, please configure the environment variables PUID and PGID. For example to run as user with uid=1000 gid=1000 use this compose.yaml:

services:
  otterwiki:
    image: redimp/otterwiki:2
    restart: unless-stopped
    environment:
      PUID: 1000
      PGID: 1000
    ports:
      - 8080:80
    volumes:
      - ./app-data:/app-data

USER in the -slim image

The -slim image is running as unpriviliged user must therefore be configured differently: In the way docker intended, with configuring the user. For example to run as user with uid=1000 gid=1000 use this compose.yaml:

services:
  otterwiki:
    image: redimp/otterwiki:2-slim
    restart: unless-stopped
    user: 1000:1000
    ports:
      - 8080:8080
    volumes:
      - ./app-data:/app-data

Make sure that the configured uid:gid has read- and write permissions to volume mounted as /app-data.

Reverse Proxy and IPs

Running the docker container behind a reverse proxy will show only the IP of the reverse proxy in the log files. With setting REAL_IP_FROM to the ip address of the reverse proxy, the IPs of the connection clients will be logged.