Otter Wiki – binglab - This is my homelab site

# Otter Wiki

## Introduction to Otter Wiki

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](https://github.com/redimp/otterwiki) or explore the [installation guide](https://github.com/redimp/otterwiki-documentation/blob/main/installation.md).

# Setting Up Otter Wiki with Docker Compose

## Docker Compose Configuration for Otter Wiki

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

### Docker Compose File (`docker-compose.yml`)

```yaml
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 Otter Wiki.
- **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 Otter Wiki 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 Otter Wiki in detached mode.
3. Access Otter Wiki 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

Video to be created!!!!