Skip to content

Add self-hosted Docker deployment guide to README - #17

Merged
t0mdavid-m merged 1 commit into
mainfrom
claude/add-deployment-guide-5MePW
May 12, 2026
Merged

t0mdavid-m merged 1 commit into
mainfrom
claude/add-deployment-guide-5MePW

Conversation

@t0mdavid-m

@t0mdavid-m t0mdavid-m commented May 12, 2026 •

Copy link
Copy Markdown
Member

Summary

Added comprehensive documentation for deploying OpenDIAKiosk using Docker on self-hosted infrastructure, including step-by-step instructions for pulling images, running containers, and managing persistent data.

Key Changes

  • Docker deployment section — New "Self-hosted deployment" section with instructions for pulling prebuilt images from GitHub Container Registry
  • Container setup guide — Detailed docker run command with explanations of key flags:
    • Port mapping for Streamlit UI access
    • Optional read-only bind-mount for MS data files with auto-detection
    • Persistent workspace volume for preserving user data across restarts
  • Remote access instructions — SSH tunnel setup for secure access when the host lacks a public IP or has firewalled ports
  • Update procedure — Clear steps for upgrading to new versions while preserving user workspaces
  • Kubernetes reference — Note directing users to separate Kubernetes deployment documentation for production cluster setups

Notable Details

  • Emphasizes that the workspace volume persists across container removals, enabling seamless upgrades
  • Explains the read-only mount strategy for data files to avoid unnecessary copying
  • Provides both interactive shell and non-interactive SSH tunnel options for different use cases

https://claude.ai/code/session_019kanESEobN34h2yi9v6hNd

Summary by CodeRabbit

  • Documentation
    • Added self-hosted deployment guide covering Docker container setup, volume configuration for data persistence, SSH tunneling options for remote access, and container update procedures.

Review Change Stack

Walk operators through pulling the prebuilt GHCR image, running it
with port exposure plus optional /mounted-data and workspace
bind-mounts, reaching the UI over an SSH tunnel when the host has no
public IP, and updating to a new version without losing workspaces.

https://claude.ai/code/session_019kanESEobN34h2yi9v6hNd
@t0mdavid-m
t0mdavid-m merged commit d58a94d into main May 12, 2026
6 of 8 checks passed
@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9af610db-311c-4d22-b0e2-972369aaf23e

📥 Commits

Reviewing files that changed from the base of the PR and between 09ae0d8 and 6b5fcc8.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

This PR adds documentation for self-hosted Docker deployment to the README, including image pull commands, volume mount configuration for persistent data and workspaces, SSH tunneling instructions for remote access, and guidance on updating containers while preserving user data.

Changes

Self-hosted Deployment Documentation

Layer / File(s) Summary
Self-hosted deployment guide
README.md
Complete Docker deployment documentation added covering GHCR image pulls, volume bind-mounts for /mounted-data and persistent workspaces, SSH port-forwarding instructions for remote access, and container update workflow notes for preserving workspace data across upgrades.

🐰 A guide so clear, in Docker it's built,
With volumes and tunnels, no guilt to be spilt,
From image to running, the path now unfolds,
Self-hosted solutions in prose, pure and bold! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/add-deployment-guide-5MePW

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants