Jeena e00195c5be Refine repository structure

- Update .gitignore for dev/ and tmp/ directories
- Move certificate setup to dev/ directory with README
- Remove production references from AGENTS.md
- Clean up directory structure and documentation
- Repository now ready for development workflow

2026-01-15 08:31:43 +09:00

1.9 KiB

Raw Blame History

Pollux - A Simple Gemini Server

Pollux is a lightweight Gemini server for serving static files securely. It supports TLS, hostname validation, and basic directory serving.

Requirements

Rust 1.70+ and Cargo.

Building

Clone or download the source, then run:

cargo build --release

This produces the target/release/pollux binary.

Running

Create a config file at /etc/pollux/config.toml or use --config to specify a path:

root = "/path/to/static/files"
cert = "certs/cert.pem"
key = "certs/key.pem"
host = "gemini.jeena.net"
port = 1965
log_level = "info"

Development Setup

Quick Start with Self-Signed Certs

mkdir -p dev
openssl req -x509 -newkey rsa:2048 \
  -keyout dev/key.pem \
  -out dev/cert.pem \
  -days 365 \
  -nodes \
  -subj "/CN=localhost"

Update config.toml:

cert = "dev/cert.pem"
key = "dev/key.pem"

Run the server:

./pollux --config /path/to/config.toml

Or specify options directly (overrides config):

./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/.

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)

Security

Uses path validation to prevent directory traversal. Validate hostnames for production use.

Certificate Management

Never commit certificate files to version control
Use development certificates only for local testing
Production certificates should be obtained via Let's Encrypt or your CA

Testing

Run cargo test for unit tests. Fix warnings before commits.

1.9 KiB Raw Blame History