mahdium/VDR
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Update README formatting for improved readability
All checks were successful
Build and Push Server Docker Image / build-server (push) Successful in 5m14s
Details

Browse Source
This commit is contained in:
Mohammad Mahdi
2025-09-05 22:13:21 +03:30
parent 864748c98c
commit 64318b0ec9
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
VirtualDDNSRouter.Server/README.md
View File

@@ -1,10 +1,12 @@
# VirtualDDNSRouter Server # 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 ## 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 ```bash
cp rules.example.yaml rules.yaml cp rules.example.yaml rules.yaml
@@ -23,6 +25,7 @@ The rules file has the following structure:
``` ```
Each entry defines a service with: Each entry defines a service with:
- `name`: A descriptive label (for documentation purposes) - `name`: A descriptive label (for documentation purposes)
- `api_key`: A secret key used by clients to authenticate updates - `api_key`: A secret key used by clients to authenticate updates
- `path`: The URL path that users will use to access the service - `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) ### 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 2. Extract the archive
3. Create your `rules.yaml` file based on `rules.example.yaml` 3. Create your `rules.yaml` file based on `rules.example.yaml`
4. Run the server: 4. Run the server:
@@ -40,7 +44,8 @@ Each entry defines a service with:
./VirtualDDNSRouter.Server ./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 ```bash
ASPNETCORE_HTTP_PORTS=8081 ./VirtualDDNSRouter.Server 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. 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: For example, if a client has configured a service with path "odoo", users can access it at:
``` ```
http://your-server:8080/goto/odoo http://your-server:8080/goto/odoo
``` ```