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

Uploaded Python 3

File details

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

File metadata

  • Download URL: otterwiki-2.2.0.tar.gz
  • Upload date:
  • Size: 7.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for otterwiki-2.2.0.tar.gz
Algorithm Hash digest
SHA256 1695319b3b2f2cc8abb190b832faa15e91b159b842c0ffd2a08205ca76a09fac
MD5 444580610194b1c47ed10dfafd79053e
BLAKE2b-256 f1ff97b655dc8ab8d95b603fbbfcb3392fdc3dc99f4ec092d76efacee043a75e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: otterwiki-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for otterwiki-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e8a4a999b27d1edd9cbd5846e7db38df29d0aa83ec5b1d85afe29c53c63a28f
MD5 d3d40b2549b77954fee219521b50670e
BLAKE2b-256 cd31b4d21c648e37145e7a80f67c7fe1eae09181d9d7f61cbef596ef744c87d6

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