Skip to main content

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.

Project description

An Otter Wiki

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.

Notable Features

  • Minimalistic interface (with dark-mode)
  • Editor with markdown highlighting and support including tables
  • Customizable Sidebar: Menu and/or Page Index
  • Full changelog and page history
  • User authentication
  • Page Attachments
  • Extended Markdown: tables, footnotes, fancy blocks, alerts and mermaid diagrams
  • (experimental) Git http server: clone, pull and push the content of your wiki
  • A very cute Otter as logo (drawn by Christy Presler CC BY 3.0)

Demo

Check out the demo https://demo.otterwiki.com.

Installation

Read the installation guide to get started. Recommended is the installation with docker-compose.

Quick start with docker-compose

  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 accessible via the internet and an domain name make sure to configure your web server accordingly. Check the installation guide for example configurations for nginx, apache and caddy.
  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.

Proceed for the configuration guide for detailed information.

docker-compose.yml

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

License

An Otter Wiki is open-source software licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

otterwiki-2.20.2.tar.gz (8.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

otterwiki-2.20.2-py3-none-any.whl (8.2 MB view details)

Uploaded Python 3

File details

Details for the file otterwiki-2.20.2.tar.gz.

File metadata

  • Download URL: otterwiki-2.20.2.tar.gz
  • Upload date:
  • Size: 8.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for otterwiki-2.20.2.tar.gz
Algorithm Hash digest
SHA256 a5d76d82f7cabfb2199a7d94e6eec84cebb304e85a8d1a956170f701a1fccffc
MD5 e62b3c7e400c8fad0f36021b58e3bf89
BLAKE2b-256 f7a70af6656f755e56582bd5aef9005969adaa7f410a4779e7e470bb476c2a87

See more details on using hashes here.

File details

Details for the file otterwiki-2.20.2-py3-none-any.whl.

File metadata

  • Download URL: otterwiki-2.20.2-py3-none-any.whl
  • Upload date:
  • Size: 8.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for otterwiki-2.20.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b6f61a3663dd3ffb72f5818ff2da6a49435079db32abe08dfc0f3f90f2408916
MD5 e0fecf3a856f44a9e54660aedcab6a51
BLAKE2b-256 6cfb4e50a618722a557a13f4377c2dde884126afea5f10f589230d8747c884aa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page