The **CPU** requirements are pretty low, you can run it on a Raspberry Pi 1 A (ARMv6). The **RAM** required is around 100MiB (according to `docker stats`). The required disk **storage** depends on the content, please keep in mind, that the backend is a git repository that never forgets: Deleting a page or an attachment does not free up any space. The wiki needs no internet access. Clients using the wiki need only access to the server running the wiki, so it can run in an environment which is _isolated_ from the internet.

As URLs as dedicated domain (e.g. `wiki.domain.tld`) is required, it can not be mapped into a subfolder.

docker run --name otterwiki \

Open the wiki via http://127.0.0.1:8080 if you are running the docker command on your machine.

For all configuration options please see [[Configuration]].

1. Create a `docker-compose.yaml` file

2. Run `docker compose up -d`

3. Access the wiki via http://127.0.0.1:8080 if run on your machine.

4. Register your account. The first account is an admin-account with access to the application settings. The first accounts email address doesn't need to be confirmed nor has the account to be activated.

5. Customize the settings to your liking.

6. It's highly recommended to use a webserver as reverse proxy to connect to the docker process, see [Reverse Proxy](#reverse-proxy) below.

Alternativly you can configure the application using environment variables, for example:

For all configuration options please see [[Configuration]].

An Otter Wiki can be run with `podman` and `podman-compose` in the same way as with` docker` and `docker compose` please see above.

The image of An Otter Wiki runs as root user (with uid=0) and comes bundled with nginx that listens on port 80. The lighter image variant is the `-slim` image: It's based on alpine, has no nginx bundled and an uWSGI server is running as unprivileged `www-data` user (with uid=33). uWSGI serves both An Otter Wiki and the static files and listens on port 8080.

Except for the exposes port, the images are interchangeable. For example a `docker-compose.yaml` running the most recent version of a `-slim` image:

The `redimp/otterwiki:2-slim` image is as stable as the 'fat' image, after all it is what is running [otterwiki.com](https://otterwiki.com).

helm repo add otterwiki https://charts.otterwiki.com

helm repo update otterwiki

Please refer to the [chart](https://github.com/redimp/otterwiki/tree/main/helm) for

a detailed README with instructions, more examples and informations about the default values

of the chart.

5. Create a virtual environment and install An Otter Wiki

6. Run uwsgi listening on the localhost port 8080

7. Open http://127.0.0.1:8080 in your browser.

8. Register your account. The first account is an admin-account with access to the application settings.

9. Alternatively can you configure the application using the `settings.cfg`. For all configuration options please see [[Configuration]].

10. Create a service file e.g. `/etc/systemd/system/otterwiki.service`

make sure to adapt the `/path/to` and that the configured User can read and write the database and the repository folder.

If you want to skip the reverse proxy consider to bind uwsgi not to just the local ip `127.0.0.1`, but to all ips of the host running An Otter Wiki with `--http 0.0.0.0:8080`.