Update README
All checks were successful
CI / build (push) Successful in 54s

This commit is contained in:
2025-12-27 11:34:41 -06:00
parent aa55beab4a
commit d9be7c07bf

View File

@@ -8,8 +8,8 @@ A modern, high-performance software distribution platform for software built and
- **High-Performance Proxy**: Proxies downloads with support for **Resumable Downloads (HTTP Range)** and modern transfer protocols.
- **Security First**:
- **Dynamic Bot Protection**: Supports external User-Agent blocklists with automatic daily updates and local caching.
- **Enhanced Fingerprinting**: Multi-header request fingerprinting (`IP`, `UA`, `Accept-Language`, `Accept-Encoding`, `Sec-CH-UA`) to prevent rate-limit collisions.
- **Secure Downloads**: Salted SHA256 download IDs to prevent "private" repository bypasses.
- **Hardened Fingerprinting**: Advanced multi-layer request fingerprinting (`IP`, `UA`, `Client Hints`, `TLS Metadata`) and stateful device tracking (`_ss_uid`) to prevent rate-limit collisions and automated abuse.
- **Secure Downloads**: Salted, persistent SHA256 download IDs to prevent repository bypasses.
- SSRF protection for proxy requests.
- Automatic SHA256 checksum verification for assets.
- **Throttling & Rate Limiting**: Intelligent download throttling (Default: 5MB/s, Speed downloaders: 1MB/s, Heavy users: 256KB/s) and global API rate limiting.
@@ -69,6 +69,18 @@ A modern, high-performance software distribution platform for software built and
./software-station -t YOUR_TOKEN -s https://your-gitea-instance.com -ua-blocklist ua-blocklist.txt
```
### Docker (Recommended)
Run Software Station using Docker Compose:
```bash
# Set your Gitea token in the environment
export GITEA_TOKEN=your_token_here
# Build and start the container
docker compose up -d
```
## Customization
### Adding Locales