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
  • Full changelog and page history
  • User authentication
  • Page Attachments
  • 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

version: '3'
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.6.2.tar.gz (7.8 MB view details)

Uploaded Source

Built Distribution

otterwiki-2.6.2-py3-none-any.whl (7.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: otterwiki-2.6.2.tar.gz
  • Upload date:
  • Size: 7.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for otterwiki-2.6.2.tar.gz
Algorithm Hash digest
SHA256 c1720e48e2d0fdb70454e16b10822b65ce2e784f97f9be9b42b6cfe99071fcaf
MD5 a650fea78083e1a0f260896125327daa
BLAKE2b-256 d972a084a363755e81fd7a0c84f26ac3fe66a9096eb3fd8dd2759e6291884a58

See more details on using hashes here.

File details

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

File metadata

  • Download URL: otterwiki-2.6.2-py3-none-any.whl
  • Upload date:
  • Size: 7.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for otterwiki-2.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a64f1a3e0940c9935877f6f5d3b19a61ae5cc05b85cac52e7d297dfd1811a244
MD5 4c68af5a865bc5210cc0c28ff52637f9
BLAKE2b-256 e1f8afc3a3ad64919dca602286c9d332e32183731e535e5cd203fe49ee4d97aa

See more details on using hashes here.

Supported by

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