jeena/pollux
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Prepare Pollux v1.0.0 release

Browse source 
- Update Cargo.toml version to 1.0.0
- Revise README.md: document available CLI options (--config, --test-processing-delay), update config format
- Update INSTALL.md: change user from gemini to pollux, simplify certificate setup, remove Let's Encrypt instructions
- Update systemd service user to pollux
- Add comprehensive CHANGELOG.md documenting all v1.0.0 features
- Remove references to eliminated CLI options (--root, --cert, --key, --host, --port)

Key features in v1.0.0:
- Rate limiting with configurable concurrent requests
- Comprehensive config validation and error handling
- Custom logging system with structured output
- Security features: path traversal protection, URI validation
- Systemd integration and complete installation guide
- Full test suite (22 tests) with zero warnings
This commit is contained in:
Jeena 2026-01-18 23:52:29 +00:00
parent bde6181820
commit c193d831ed
5 changed files with 55 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -24,9 +24,11 @@ Create a config file at `/etc/pollux/config.toml` or use `--config` to specify a
root = "/path/to/static/files"
cert = "/path/to/cert.pem"
key = "/path/to/key.pem"
host = "gemini.example.com"
bind_host = "0.0.0.0"
hostname = "gemini.example.com"
port = 1965
log_level = "info"
max_concurrent_requests = 1000
```
## Development Setup
@ -54,12 +56,6 @@ Run the server:
./pollux --config /path/to/config.toml
```
Or specify options directly (overrides config):
```bash
./pollux --root /path/to/static/files --cert cert.pem --key key.pem --host yourdomain.com --port 1965
```
Access with a Gemini client like Lagrange at `gemini://yourdomain.com/`.
### Development Notes
@ -70,12 +66,8 @@ Access with a Gemini client like Lagrange at `gemini://yourdomain.com/`.
## Options
- `--config`: Path to config file (default `/etc/pollux/config.toml`)
- `--root`: Directory to serve files from (required)
- `--cert`: Path to certificate file (required)
- `--key`: Path to private key file (required)
- `--host`: Hostname for validation (required)
- `--port`: Port to listen on (default 1965)
- `--config` (`-C`): Path to config file (default `/etc/pollux/config.toml`)
- `--test-processing-delay` (debug builds only): Add delay before processing requests (seconds) - for testing rate limiting
### Certificate Management