From 64318b0ec9d84cbfda0fb274248c0b643eba0d8b Mon Sep 17 00:00:00 2001 From: Mohammad Mahdi Date: Fri, 5 Sep 2025 22:13:21 +0330 Subject: [PATCH] Update README formatting for improved readability --- VirtualDDNSRouter.Server/README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/VirtualDDNSRouter.Server/README.md b/VirtualDDNSRouter.Server/README.md index a1b71c4..833ac2c 100644 --- a/VirtualDDNSRouter.Server/README.md +++ b/VirtualDDNSRouter.Server/README.md @@ -1,10 +1,12 @@ # VirtualDDNSRouter Server -The VirtualDDNSRouter Server is a lightweight reverse proxy that maintains dynamic mappings between paths and IP addresses. Clients can update their IP addresses, and users can access services through consistent URLs. +The VirtualDDNSRouter Server is a lightweight reverse proxy that maintains dynamic mappings between paths and IP +addresses. Clients can update their IP addresses, and users can access services through consistent URLs. ## Configuration -The server uses a YAML rules file named `rules.yaml`. You can create this file by copying and modifying the provided example: +The server uses a YAML rules file named `rules.yaml`. You can create this file by copying and modifying the provided +example: ```bash cp rules.example.yaml rules.yaml @@ -23,6 +25,7 @@ The rules file has the following structure: ``` Each entry defines a service with: + - `name`: A descriptive label (for documentation purposes) - `api_key`: A secret key used by clients to authenticate updates - `path`: The URL path that users will use to access the service @@ -31,7 +34,8 @@ Each entry defines a service with: ### Method 1: Downloading Pre-built Binaries (Recommended) -1. Download the latest server binary from [https://git.mahdium.ir/mahdium/VDR/releases/latest](https://git.mahdium.ir/mahdium/VDR/releases/latest) +1. Download the latest server binary + from [https://git.mahdium.ir/mahdium/VDR/releases/latest](https://git.mahdium.ir/mahdium/VDR/releases/latest) 2. Extract the archive 3. Create your `rules.yaml` file based on `rules.example.yaml` 4. Run the server: @@ -40,7 +44,8 @@ Each entry defines a service with: ./VirtualDDNSRouter.Server ``` -By default, the server listens on port 8080. You can change this by setting the `ASPNETCORE_HTTP_PORTS` environment variable: +By default, the server listens on port 8080. You can change this by setting the `ASPNETCORE_HTTP_PORTS` environment +variable: ```bash ASPNETCORE_HTTP_PORTS=8081 ./VirtualDDNSRouter.Server @@ -76,6 +81,7 @@ The server provides two main endpoints: Users access this endpoint to reach the service associated with the path. For example, if a client has configured a service with path "odoo", users can access it at: + ``` http://your-server:8080/goto/odoo ```