Home A - Z

Otter Wiki

description: Excalidraw is a virtual collaborative whiteboard tool that lets you easily sketch diagrams with a hand-drawn feel. It's designed to be simple, intuitive, and to allow rapid collaboration.

Setting Up Otter Wiki with Docker Compose

Introduction to Excalidraw

OtterWiki is a minimalistic wiki powered by Python, Markdown, and Git. It is designed for collaborative content management, allowing users to store and track changes in a Git repository. OtterWiki uses the Flask microframework, Halfmoon CSS framework, and CodeMirror editor for a streamlined experience. Some notable features include:

  • Markdown highlighting with support for tables, footnotes, and alerts
  • Customizable sidebar for navigation
  • Full changelog and page history
  • User authentication and page attachments
  • Git HTTP server for cloning, pulling, and pushing wiki content

You can check out the project on GitHub or explore the installation guide. Let me know if you need help setting it up! 🚀

Docker Compose Configuration for Excalidraw

This Docker Compose setup deploys Excalidraw in a Docker container, offering an isolated environment for your sketching and collaboration needs.

Docker Compose File (docker-compose.yml)

services:
  otterwiki:
    image: redimp/otterwiki:2
    restart: unless-stopped
    ports:
      - 8083:80
    volumes:
      - ./app-data:/app-data

Key Components of the Configuration

Service: otterwiki

  • Image: redimp/otterwiki:2 is the Docker image used for Excalidraw.
  • Ports:
    • 8083:80 maps port 8083 on the host to port 80 in the container, where Otter wiki web interface is accessible.
  • Restart Policy: unless-stopped ensures that the Excalidraw service restarts automatically in case of failure.

Deploying Otter wiki

  1. Save the Docker Compose configuration in a docker-compose.yml file.
  2. Run docker compose up -d to start Excalidraw in detached mode.
  3. Access Excalidraw by navigating to http://<host-ip>:8083.

Configuring and Using Otter Wiki

After deployment, Otter Wiki is ready to use through its web interface, providing a collaborative platform for markdown documentation.

Youtube Video

---

If there is an issue with this guide or you wish to suggest changes, please raise an issue.