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.6.tar.gz (8.7 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.6-py3-none-any.whl (8.8 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: otterwiki-2.20.6.tar.gz
  • Upload date:
  • Size: 8.7 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.6.tar.gz
Algorithm Hash digest
SHA256 cff2bf0bfbc1542d170210057a531c0139c24f7a894e8ed70b47fcb338e2ac83
MD5 7739c552379acdb5d16237772fafa888
BLAKE2b-256 eeefb623e51030af169cfc5d3754845d88890c4a5006ecb1abad634dc8c79053

See more details on using hashes here.

File details

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

File metadata

  • Download URL: otterwiki-2.20.6-py3-none-any.whl
  • Upload date:
  • Size: 8.8 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 24835868b42f94956283503dd58e40531c0e23cf8b0239b2befdbf12c669768c
MD5 29877e97164886e0aa3317906923d7c6
BLAKE2b-256 8655530daca056255e4cddfaa1e9468a4880105e33a80245336dc4dcac000034

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