An Otter Wiki is Python-based software for collaborative content management, called a wiki. The content is stored in a git repository, which keeps track of all changes. Markdown is used as Markup language. An Otter Wiki is written in python using the microframework Flask. halfmoon is used as CSS framework and CodeMirror as editor. Font Awesome Free serves the icons.

• Minimalistic interface (with dark-mode)
• Full changelog and page history
• User authentication
• Page Attachments
• A very cute Otter as logo (drawn by Christy Presler CC BY 3.0).

1. Copy and edit the docker-compose.yml below to match your preferences.
2. Run docker-compose up -d
3. Access the wiki via http://127.0.0.1:8080 if run on your machine.
4. If the wiki shall be accessable via the internet and an domainname make sure to configure your web server accordingly. For Nginx e.g., see Nginx Reverse Proxy
5. Register your account. The first account is an admin-account giving you access to the settings tab.
6. Customize the settings to your liking.

version: '3'
services:
  otterwiki:
    image: redimp/otterwiki:latest
    restart: unless-stopped
    ports:
      - 8080:80
    volumes:
      - ./app-data:/app-data

An Otter Wiki is configured in the application via the Settings menu as admin user. For development you can use the settings.cfg, see below.

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.

An Otter Wiki is using Flask-Mail.

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.

1. Install the prerequisites
   1. Debian / Ubuntu

   apt install git build-essential python3-dev python3-venv

   2. RHEL8 / Fedora / Centos8 / Rocky Linux 8

   yum install make python3-devel

2. Clone the otterwiki repository and enter the directory

git clone https://github.com/redimp/otterwiki.git
cd otterwiki

3. Create and initialize the repository where the otterwiki data lives

mkdir -p app-data/repository
# initialize the empty repository
git init app-data/repository

4. Create a minimal configuration file

echo "REPOSITORY='${PWD}/app-data/repository'" >> settings.cfg
echo "SQLALCHEMY_DATABASE_URI='sqlite:///${PWD}/app-data/db.sqlite'" >> settings.cfg
echo "SECRET_KEY='$(echo $RANDOM | md5sum | head -c 16)'" >> settings.cfg 

5. Run make to setup a virtual environment and run a local server on port 8080.

make debug

6. Open the wiki in your browser http://127.0.0.1:8080. You can create and edit pages as anonymous user without any further configuration. Please note: This setup is not for production use!
7. Edit the code, flask will automatically reload the server, just refresh your browser.
8. Run the tests

make test

9. Run the coverage tests, and check coverage_html/index.html.

make coverage

1. You can setup a virtual environemnt using make venv or create a virtual environment manually an pip install -e . the source tree into it.
2. Setup environment variables:
   • FLASK_DEBUG=True
   • FLASK_APP=otterwiki.server
   • OTTERWIKI_SETTINGS=../settings.cfg
3. Run server.py or flask run --host 0.0.0.0 --port 8080 from the virtual environment.