Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.23 KB

README.md

File metadata and controls

63 lines (47 loc) · 2.23 KB
Raw

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.