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.7.0.tar.gz (7.8 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for otterwiki-2.7.0.tar.gz
Algorithm Hash digest
SHA256 8292b3451a225b329ccdb9b3f43051ac8692b37f810c9980db73949a55509e2d
MD5 49cda24b13d1ec68aa601facf473298d
BLAKE2b-256 df93e9f6d27197bbff1d30c987bb15ec4b96730042057608867d045997c7f387

See more details on using hashes here.

File details

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

File metadata

  • Download URL: otterwiki-2.7.0-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.13.0

File hashes

Hashes for otterwiki-2.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 efb3fa7daf3f4554bf1493c7ba572a56d9598b0cc01c6b51a29fc301395ed488
MD5 d5715e713d052f72d4bc758263eaf632
BLAKE2b-256 2067aa35c139e3d12f84e7aa88b7076170d46f2d6130d9769c1fe30024977800

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