diff --git a/README.md b/README.md index baee13c..ea85d4b 100644 --- a/README.md +++ b/README.md @@ -81,14 +81,14 @@ Deploy your own private relay server using our official image: docker pull ghcr.io/shik3i/koalasync:latest # Or use our example compose file -cp docker-compose.caddy.example.yml docker-compose.yml +cp examples/docker-compose.caddy.example.yml docker-compose.yml docker-compose up -d ``` -The server will be available at `ws://localhost:3000`. See [Docker network compose](docker-compose.caddy.example.yml) or [Static IP compose](docker-compose.ip.example.yml) for ready-to-use Docker Compose files. +The server will be available at `ws://localhost:3000`. See [Docker network compose](examples/docker-compose.caddy.example.yml) or [Static IP compose](examples/docker-compose.ip.example.yml) for ready-to-use Docker Compose files. To connect your extension to a self-hosted server, open the popup → **Room** tab → select **Custom Server** → enter your server's WebSocket URL (e.g., `ws://localhost:3000`). -> **⚠️ Note**: `ws://` only works for `localhost`. If you deploy to a real domain, you **must** use `wss://` (e.g., `wss://sync.yourdomain.com`). This requires a TLS-terminating reverse proxy (e.g., Caddy, Nginx, or Traefik) in front of the relay server. See [Caddyfile.example](Caddyfile.example) for a production-ready template. +> **⚠️ Note**: `ws://` only works for `localhost`. If you deploy to a real domain, you **must** use `wss://` (e.g., `wss://sync.yourdomain.com`). This requires a TLS-terminating reverse proxy (e.g., Caddy, Nginx, or Traefik) in front of the relay server. See [Caddyfile.example](examples/Caddyfile.example) for a production-ready template. To verify your relay is reachable from outside, visit `https://your-domain.com` in a browser — it should return `{"status":"online","service":"KoalaSync Relay"}`. @@ -115,7 +115,7 @@ Both the official KoalaSync website and the **v2.0 Browser Extension** feature f - **[HOW_IT_WORKS.md](docs/HOW_IT_WORKS.md)**: Step-by-step walkthrough of the complete user flow. - **[ARCHITECTURE.md](docs/ARCHITECTURE.md)**: Deep-dive into the two-phase sync and heartbeat logic. - **[SECURITY.md](SECURITY.md)**: Disclosure policy and security practices. -- **[Caddyfile.example](Caddyfile.example)**: Production Caddy configuration for website and relay. +- **[Caddyfile.example](examples/Caddyfile.example)**: Production Caddy configuration for website and relay. --- diff --git a/Caddyfile.example b/examples/Caddyfile.example similarity index 100% rename from Caddyfile.example rename to examples/Caddyfile.example diff --git a/docker-compose.caddy.example.yml b/examples/docker-compose.caddy.example.yml similarity index 100% rename from docker-compose.caddy.example.yml rename to examples/docker-compose.caddy.example.yml diff --git a/docker-compose.ip.example.yml b/examples/docker-compose.ip.example.yml similarity index 100% rename from docker-compose.ip.example.yml rename to examples/docker-compose.ip.example.yml diff --git a/json_exporter.example.yml b/examples/json_exporter.example.yml similarity index 98% rename from json_exporter.example.yml rename to examples/json_exporter.example.yml index 2d157dd..c89ed0b 100644 --- a/json_exporter.example.yml +++ b/examples/json_exporter.example.yml @@ -1,5 +1,5 @@ # Prometheus Community JSON Exporter Configuration Example -# File: json_exporter.example.yml +# File: examples/json_exporter.example.yml # # Use this configuration to map KoalaSync admin health metrics (JSON) # to native Prometheus metrics. diff --git a/server/README.md b/server/README.md index 2db50dd..2ed4367 100644 --- a/server/README.md +++ b/server/README.md @@ -54,7 +54,7 @@ docker pull ghcr.io/shik3i/koalasync:latest # Or build from the repository root docker build -t koala-sync-server -f server/Dockerfile . ``` -See [Docker network compose](../docker-compose.caddy.example.yml) or [Static IP compose](../docker-compose.ip.example.yml) in the root directory for ready-to-use Docker Compose files. +See [Docker network compose](../examples/docker-compose.caddy.example.yml) or [Static IP compose](../examples/docker-compose.ip.example.yml) in the root directory for ready-to-use Docker Compose files. ### Manual Setup ```bash diff --git a/website/README.md b/website/README.md index cf6c62a..7f0cb0f 100644 --- a/website/README.md +++ b/website/README.md @@ -28,7 +28,7 @@ Caddy is the recommended web server. It provides automatic HTTPS and high-perfor ### Recommended Caddyfile -For a more comprehensive configuration that includes the Relay Server reverse proxy, see the root [Caddyfile.example](../Caddyfile.example). +For a more comprehensive configuration that includes the Relay Server reverse proxy, see the root [Caddyfile.example](../examples/Caddyfile.example). ```caddy sync.koalastuff.net {