Skip to content

Commit

Permalink
chore(env): include repo link in the default UA
Browse files Browse the repository at this point in the history
Signed-off-by: Rongrong <[email protected]>
  • Loading branch information
Rongronggg9 committed Oct 27, 2024
1 parent d468931 commit 6bb9dc4
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .env.sample
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ TELEGRAPH_TOKEN="
#API_HASH=452b0359b988148995f22ff0f4229750 # get it from https://core.telegram.org/api/obtaining_api_id
#IMG_RELAY_SERVER=https://wsrv.nl/?url= # default: https://rsstt-img-relay.rongrong.workers.dev/
#IMAGES_WESERV_NL=https://t0.nl/ # default: https://wsrv.nl/
#USER_AGENT=Mozilla/5.0 (Android 12; Mobile; rv:68.0) Gecko/68.0 Firefox/96.0 # default: RSStT/2.x RSS Reader
#USER_AGENT=Mozilla/5.0 # default: RSStT/* RSS Reader (+https://git.io/RSStT)
#IPV6_PRIOR=1 # default: 0
#VERIFY_TLS=0 # default: 1
#T_PROXY=socks5://172.17.0.1:1080 # Proxy used to connect to the Telegram API
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml.sample
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ services:
#- API_HASH=452b0359b988148995f22ff0f4229750 # get it from https://core.telegram.org/api/obtaining_api_id
#- IMG_RELAY_SERVER=https://wsrv.nl/?url= # default: https://rsstt-img-relay.rongrong.workers.dev/
#- IMAGES_WESERV_NL=https://t0.nl/ # default: https://wsrv.nl/
#- USER_AGENT=Mozilla/5.0 (Android 12; Mobile; rv:68.0) Gecko/68.0 Firefox/96.0 # default: RSStT/2.x RSS Reader
#- USER_AGENT=Mozilla/5.0 # default: RSStT/* RSS Reader (+https://git.io/RSStT)
#- IPV6_PRIOR=1 # default: 0
#- VERIFY_TLS=0 # default: 1
#- T_PROXY=socks5://172.17.0.1:1080 # Proxy used to connect to the Telegram API
Expand Down
28 changes: 14 additions & 14 deletions docs/advanced-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,20 @@

### Network settings

| Key | Description | Example | Default |
|-----------------------------|-------------------------------------------------------|--------------------------------|-----------------------------|
| `T_PROXY` | Proxy used to connect to the Telegram API [^3] | `socks5://172.17.0.1:1080` | |
| `R_PROXY` | Proxy used to fetch feeds [^3] | `socks5://172.17.0.1:1080` | |
| `PROXY_BYPASS_PRIVATE` | Bypass proxy for private IPs or not? | `1` | `0` |
| `PROXY_BYPASS_DOMAINS` | Bypass proxy for listed domains | `example.com;example.net` [^1] | |
| `USER_AGENT` | User-Agent | `Mozilla/5.0` | `RSStT/$VERSION RSS Reader` |
| `IPV6_PRIOR` | Enforce fetching feeds over IPv6 firstly or not? [^4] | `1` | `0` |
| `VERIFY_TLS` | Verify TLS certificate or not? | `0` | `1` |
| `TRAFFIC_SAVING` | Enable network traffic saving mode or not? [^5] | `1` | `0` |
| `LAZY_MEDIA_VALIDATION` | Let Telegram DC to validate media or not? [^6] | `1` | `0` |
| `HTTP_TIMEOUT` | HTTP request timeout in seconds | `60` | `12` |
| `HTTP_CONCURRENCY` | HTTP request concurrency overall (0=unlimited) | `0` | `1024` |
| `HTTP_CONCURRENCY_PER_HOST` | HTTP request concurrency per host (0=unlimited) | `0` | `16` |
| Key | Description | Example | Default |
|-----------------------------|-------------------------------------------------------|--------------------------------|-----------------------------------------------------|
| `T_PROXY` | Proxy used to connect to the Telegram API [^3] | `socks5://172.17.0.1:1080` | |
| `R_PROXY` | Proxy used to fetch feeds [^3] | `socks5://172.17.0.1:1080` | |
| `PROXY_BYPASS_PRIVATE` | Bypass proxy for private IPs or not? | `1` | `0` |
| `PROXY_BYPASS_DOMAINS` | Bypass proxy for listed domains | `example.com;example.net` [^1] | |
| `USER_AGENT` | User-Agent | `Mozilla/5.0` | `RSStT/$VERSION RSS Reader (+https://git.io/RSStT)` |
| `IPV6_PRIOR` | Enforce fetching feeds over IPv6 firstly or not? [^4] | `1` | `0` |
| `VERIFY_TLS` | Verify TLS certificate or not? | `0` | `1` |
| `TRAFFIC_SAVING` | Enable network traffic saving mode or not? [^5] | `1` | `0` |
| `LAZY_MEDIA_VALIDATION` | Let Telegram DC to validate media or not? [^6] | `1` | `0` |
| `HTTP_TIMEOUT` | HTTP request timeout in seconds | `60` | `12` |
| `HTTP_CONCURRENCY` | HTTP request concurrency overall (0=unlimited) | `0` | `1024` |
| `HTTP_CONCURRENCY_PER_HOST` | HTTP request concurrency per host (0=unlimited) | `0` | `16` |

### Misc settings

Expand Down
2 changes: 1 addition & 1 deletion src/env.py
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ def __get_version():

PROXY_BYPASS_PRIVATE: Final = __bool_parser(os.environ.get('PROXY_BYPASS_PRIVATE'))
PROXY_BYPASS_DOMAINS: Final = __list_parser(os.environ.get('PROXY_BYPASS_DOMAINS'))
USER_AGENT: Final = os.environ.get('USER_AGENT') or f'RSStT/{__version__} RSS Reader'
USER_AGENT: Final = os.environ.get('USER_AGENT') or f'RSStT/{__version__} RSS Reader (+https://git.io/RSStT)'
IPV6_PRIOR: Final = __bool_parser(os.environ.get('IPV6_PRIOR'))
VERIFY_TLS: Final = __bool_parser(os.environ.get('VERIFY_TLS'), default_value=True)

Expand Down

0 comments on commit 6bb9dc4

Please sign in to comment.