From fa3d0d36911fda2f9563cb584cc769b5549fb0d4 Mon Sep 17 00:00:00 2001 From: Your Name Date: Sat, 11 Jul 2026 07:27:54 +0900 Subject: [PATCH] fix: make Docker Compose and Docker Run sections self-contained - Add mkdir, curl/Invoke-WebRequest commands inline in both Docker sections - Add PowerShell code blocks for Windows users - Each section is now a complete copy-paste solution - Fixes the issue where config.yaml was created as a directory by Docker when users jumped directly to the Docker Compose section without completing prerequisite setup steps --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d6154d7a..2cc57eaa 100644 --- a/README.md +++ b/README.md @@ -118,10 +118,12 @@ Use the pre-built image directly from GHCR - no building required! > 💡 **Multi-Architecture Support**: Docker images are available for both `x86_64` and `ARM64` (Raspberry Pi, Apple Silicon, etc.) ```bash -# Download the docker-compose file +# Linux/macOS - Create required directories and files, then start +mkdir -p data plugins themes +curl -O https://raw.githubusercontent.com/gamosoft/notediscovery/main/config.yaml +curl -o themes/light.css https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/light.css +curl -o themes/dark.css https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/dark.css curl -O https://raw.githubusercontent.com/gamosoft/notediscovery/main/docker-compose.ghcr.yml - -# Or if you cloned the repo, just use it directly docker-compose -f docker-compose.ghcr.yml up -d # Access at http://localhost:8000 @@ -134,10 +136,24 @@ docker-compose -f docker-compose.ghcr.yml logs -f docker-compose -f docker-compose.ghcr.yml down ``` +```powershell +# Windows PowerShell +mkdir data, plugins, themes -Force +Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/config.yaml -OutFile config.yaml +Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/light.css -OutFile themes/light.css +Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/dark.css -OutFile themes/dark.css +Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/docker-compose.ghcr.yml -OutFile docker-compose.ghcr.yml +docker-compose -f docker-compose.ghcr.yml up -d +``` + **Option 2: Docker Run (Alternative)** ```bash # Linux/macOS +mkdir -p data plugins themes +curl -O https://raw.githubusercontent.com/gamosoft/notediscovery/main/config.yaml +curl -o themes/light.css https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/light.css +curl -o themes/dark.css https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/dark.css docker run -d \ --name notediscovery \ -p 8000:8000 \ @@ -152,6 +168,10 @@ docker run -d \ ```powershell # Windows PowerShell +mkdir data, plugins, themes -Force +Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/config.yaml -OutFile config.yaml +Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/light.css -OutFile themes/light.css +Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/dark.css -OutFile themes/dark.css docker run -d ` --name notediscovery ` -p 8000:8000 `