ske087/qr-code_manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Replace specific domain with generic placeholder

Browse Source 
- Changed qr.moto-adv.com to [your-domain] throughout documentation
- Made documentation more generic and reusable for any deployment
- Updated Nginx configuration examples with placeholder domain
- Standardized domain references in all configuration sections
This commit is contained in:
ske087
2025-07-16 17:57:06 -04:00
parent 7e28c3f365
commit 8dbcec974e
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -290,7 +290,7 @@ The application is fully containerized with Docker:
SECRET_KEY=your-super-secret-key-here SECRET_KEY=your-super-secret-key-here
ADMIN_USERNAME=your-admin-username ADMIN_USERNAME=your-admin-username
ADMIN_PASSWORD=your-secure-password ADMIN_PASSWORD=your-secure-password
APP_DOMAIN=qr.moto-adv.com # Your custom domain for URL shortener APP_DOMAIN=[your-domain] # Your custom domain for URL shortener
``` ```
2. **Deploy:** 2. **Deploy:**
@@ -303,7 +303,7 @@ The application is fully containerized with Docker:
The URL shortener feature uses the `APP_DOMAIN` environment variable to generate short URLs: The URL shortener feature uses the `APP_DOMAIN` environment variable to generate short URLs:
- **Development**: `APP_DOMAIN=localhost:5000` - **Development**: `APP_DOMAIN=localhost:5000`
- **Production**: `APP_DOMAIN=qr.moto-adv.com` or `APP_DOMAIN=https://qr.moto-adv.com` - **Production**: `APP_DOMAIN=[your-domain]` or `APP_DOMAIN=https://[your-domain]`
Short URLs will be available at: `https://[your-domain]/s/[short-code]` Short URLs will be available at: `https://[your-domain]/s/[short-code]`
@@ -320,7 +320,7 @@ When deploying behind a reverse proxy like Nginx Proxy Manager or standard Nginx
### Nginx Proxy Manager Setup ### Nginx Proxy Manager Setup
1. **Create Proxy Host**: 1. **Create Proxy Host**:
- Domain: `qr.moto-adv.com` (your domain) - Domain: `[your-domain]` (your domain)
- Forward Hostname/IP: `your-server-ip` - Forward Hostname/IP: `your-server-ip`
- Forward Port: `8066` - Forward Port: `8066`
- **Protocol**: HTTP (not HTTPS) - **Protocol**: HTTP (not HTTPS)
@@ -344,7 +344,7 @@ When deploying behind a reverse proxy like Nginx Proxy Manager or standard Nginx
```nginx ```nginx
server { server {
listen 443 ssl http2; listen 443 ssl http2;
server_name qr.moto-adv.com; server_name [your-domain];
# SSL Configuration # SSL Configuration
ssl_certificate /path/to/ssl/cert.pem; ssl_certificate /path/to/ssl/cert.pem;
@@ -365,7 +365,7 @@ server {
# Redirect HTTP to HTTPS # Redirect HTTP to HTTPS
server { server {
listen 80; listen 80;
server_name qr.moto-adv.com; server_name [your-domain];
return 301 https://$server_name$request_uri; return 301 https://$server_name$request_uri;
} }
``` ```
@@ -389,7 +389,7 @@ services:
ports: ports:
- "8066:5000" # Maps container port 5000 to host port 8066 - "8066:5000" # Maps container port 5000 to host port 8066
environment: environment:
- APP_DOMAIN=qr.moto-adv.com # Your public domain - APP_DOMAIN=[your-domain] # Your public domain
``` ```
## 📱 Usage ## 📱 Usage
@@ -420,7 +420,7 @@ services:
**Examples:** **Examples:**
- Original: `https://very-long-domain.com/extremely/long/path/to/resource` - Original: `https://very-long-domain.com/extremely/long/path/to/resource`
- Short: `https://qr.moto-adv.com/s/abc123` - Short: `https://[your-domain]/s/abc123`
## 🛡️ Security Features ## 🛡️ Security Features