WIKI

Mnemos Wiki

Web interface for browsing the Mnemos knowledge base.

Quick Start

Prerequisites: nginx-proxy and Let’s Encrypt companion running

# Check SSL setup
make check-ssl

# Start the wiki
make up

# Stop the wiki  
make down

# View logs
make wiki-logs

Access at: https://mnemos.lyra.moul.io (or your configured domain)

Configuration

Copy .env.example to .env and customize:

cp .env.example .env

Environment Variables

Usage

Production (Default)

By default, the wiki only works with nginx-proxy:

make up

Access at: https://mnemos.lyra.moul.io

Local Development

For local development:

make wiki-dev

This automatically creates the override file and starts the wiki on http://localhost:3000

With SSL (Production)

VIRTUAL_HOST=mnemos.yourdomain.com \
LETSENCRYPT_HOST=mnemos.yourdomain.com \
LETSENCRYPT_EMAIL=you@yourdomain.com \
make up

Features

Architecture

The wiki server:

  1. Scans all .md files in the repository
  2. Parses YAML frontmatter for metadata
  3. Processes markdown with wiki-link support
  4. Serves a web interface with search and filtering
  5. Watches for file changes in development mode

Development

# Build and start
make up

# View logs
make wiki-logs

# Shell into container
make wiki-shell

# Restart (rebuild)
make wiki-restart

SSL/TLS Setup

The wiki is configured for automatic HTTPS via Let’s Encrypt:

Prerequisites

  1. nginx-proxy running:
docker run -d -p 80:80 -p 443:443 --name nginx-proxy \
  -v /var/run/docker.sock:/tmp/docker.sock:ro \
  jwilder/nginx-proxy
  1. Let’s Encrypt companion:
docker run -d --name nginx-proxy-letsencrypt \
  --volumes-from nginx-proxy \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  -v /var/lib/docker/containers:/var/lib/docker/containers:ro \
  jrcs/letsencrypt-nginx-proxy-companion
  1. DNS Configuration: Ensure mnemos.lyra.moul.io points to your server

Verification

# Check if everything is set up correctly
make check-ssl

# Start wiki (SSL certificate will be generated automatically)
make up

# Verify HTTPS works
curl -I https://mnemos.lyra.moul.io

Docker Networks

The setup creates:

SSL certificates are automatically generated and renewed by the Let’s Encrypt companion.

Nginx Proxy Integration

The docker-compose file is configured to work with:

Environment variables automatically configure:

← Back to Knowledge Base