Blame
| 350643 | MB Tech | 2025-07-28 01:42:34 | 1 | # Otter Wiki |
| 2 | ||||
| 3 | ## Introduction to Otter Wiki |
|||
| 4 | ||||
| 5 | 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: |
|||
| 6 | - **Markdown highlighting** with support for tables, footnotes, and alerts |
|||
| 7 | - **Customizable sidebar** for navigation |
|||
| 8 | - **Full changelog and page history** |
|||
| 9 | - **User authentication** and page attachments |
|||
| 10 | - **Git HTTP server** for cloning, pulling, and pushing wiki content |
|||
| 11 | ||||
| 12 | You can check out the project on [GitHub](https://github.com/redimp/otterwiki) or explore the [installation guide](https://github.com/redimp/otterwiki-documentation/blob/main/installation.md). |
|||
| 13 | ||||
| 14 | # Setting Up Otter Wiki with Docker Compose |
|||
| 15 | ||||
| 16 | ## Docker Compose Configuration for Otter Wiki |
|||
| 17 | ||||
| 18 | This Docker Compose setup deploys Otter Wiki in a Docker container, offering an isolated environment for your sketching and collaboration needs. |
|||
| 19 | ||||
| 20 | ### Docker Compose File (`docker-compose.yml`) |
|||
| 21 | ||||
| 22 | ```yaml |
|||
| 23 | services: |
|||
| 24 | otterwiki: |
|||
| 25 | image: redimp/otterwiki:2 |
|||
| 26 | restart: unless-stopped |
|||
| 27 | ports: |
|||
| 28 | - 8083:80 |
|||
| 29 | volumes: |
|||
| 30 | - ./app-data:/app-data |
|||
| 31 | ``` |
|||
| 32 | ||||
| 33 | ## Key Components of the Configuration |
|||
| 34 | ### Service: otterwiki |
|||
| 35 | - **Image**: `redimp/otterwiki:2` is the Docker image used for Otter Wiki. |
|||
| 36 | - **Ports**: |
|||
| 37 | - `8083:80` maps port 8083 on the host to port 80 in the container, where Otter wiki web interface is accessible. |
|||
| 38 | - **Restart Policy**: `unless-stopped` ensures that the Otter Wiki service restarts automatically in case of failure. |
|||
| 39 | ||||
| 40 | ## Deploying Otter wiki |
|||
| 41 | ||||
| 42 | 1. Save the Docker Compose configuration in a `docker-compose.yml` file. |
|||
| 43 | 2. Run `docker compose up -d` to start Otter Wiki in detached mode. |
|||
| 44 | 3. Access Otter Wiki by navigating to `http://<host-ip>:8083`. |
|||
| 45 | ||||
| 46 | ## Configuring and Using Otter Wiki |
|||
| 47 | ||||
| 48 | After deployment, Otter Wiki is ready to use through its web interface, providing a collaborative platform for markdown documentation. |
|||
| 49 | ||||
| 50 | ||||
| 51 | ## Youtube Video |
|||
| 52 | ||||
| 53 | Video to be created!!!! |