diff --git a/Docker-Desktop-WSL-Windows.md b/Docker-Desktop-WSL-Windows.md new file mode 100644 index 0000000..4cae47c --- /dev/null +++ b/Docker-Desktop-WSL-Windows.md @@ -0,0 +1,109 @@ +# Running Romexis Docker on Windows with Docker Desktop and WSL 2 + +## Purpose + +This guide explains how to run the Romexis Docker stack on Windows using Docker Desktop with the WSL 2 backend. + +Official documentation: +https://docs.docker.com/desktop/features/wsl/ + +## Requirements + +- Windows 10/11 +- WSL 2 +- Docker Desktop +- Ubuntu (recommended) + +## Install WSL + +```powershell +wsl --install +wsl -l -v +``` + +## Enable Docker Desktop WSL Integration + +Docker Desktop → Settings → Resources → WSL Integration + +Enable your Ubuntu distribution. + +Verify: + +```bash +docker version +docker compose version +``` + +## Recommended Directory Layout + +```text +/srv/romexis-docker +/srv/romexis-data +/srv/romexis-backup +``` + +Create directories: + +```bash +sudo mkdir -p /srv/romexis-docker /srv/romexis-data /srv/romexis-backup +sudo chown -R $USER:$USER /srv/romexis-docker /srv/romexis-data /srv/romexis-backup +``` + +## Configure + +```bash +cp .env.sample .env +nano .env +``` + +Example: + +```env +ROMEXIS_VERSION=6.5.3.444.203 +SERVER_DB=5 +HOST_IP=192.168.1.100 +ROMEXIS_DATA_ROOT=/srv/romexis-data +DATABASE_BACKUP_DIR=/srv/romexis-backup +``` + +Firebird: + +```env +SERVER_DB=4 +FIREBIRD_USER=sysdba +FIREBIRD_PASSWORD=pwr0mex! +ROMEXIS_DB_URL=jdbc:firebirdsql://firebird:3050//firebird/data/romexis.fdb +``` + +## Start + +```bash +docker compose up -d +docker compose ps +docker compose logs -f romexis +``` + +## Useful Commands + +```bash +docker compose exec romexis bash +docker buildx prune -a -f +docker compose build --no-cache --pull +docker compose up -d --force-recreate +``` + +## Troubleshooting + +### Docker not found + +Enable WSL integration. + +### Slow performance + +Store the project under `/srv` instead of `/mnt/c`. + +### Debug a container + +```bash +docker compose run --rm --entrypoint /bin/bash romexis +``` diff --git a/_Sidebar.md b/_Sidebar.md index 8a5cbe8..a726055 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -6,6 +6,7 @@ - [Project Overview](Project-Overview) - [Architecture](Architecture) - [Quick Start](Quick-Start) +- [Use with Docker + WSL in Windows](Docker-Desktop-WSL-Windows) - [Configuration](Configuration) - [Container Images](Container-Images)