References
📚 External resources and documentation references
This page collects official documentation, tutorials, and resources referenced throughout the PiSovereign documentation.
Hardware
Raspberry Pi 5
| Resource | Description |
|---|---|
| Raspberry Pi 5 Product Page | Official product information |
| Raspberry Pi 5 Documentation | Hardware specifications and setup |
| Raspberry Pi OS | Operating system downloads |
| Raspberry Pi Imager | SD card flashing tool |
| GPIO Pinout | Interactive pinout reference |
Hailo AI Accelerator
| Resource | Description |
|---|---|
| Hailo-10H AI HAT+ Product Page | Official product information |
| Hailo Developer Zone | SDKs, tools, and documentation |
| HailoRT SDK 4.20 Documentation | Runtime SDK reference |
| Hailo Model Zoo | Pre-compiled models |
| Hailo-Ollama GitHub | Ollama-compatible inference server |
Storage
| Resource | Description |
|---|---|
| NVMe SSD Compatibility | NVMe boot support |
| PCIe HAT+ Documentation | PCIe expansion |
Rust Ecosystem
Language & Tools
| Resource | Description |
|---|---|
| The Rust Programming Language | Official Rust book |
| Rust by Example | Learn Rust through examples |
| Rust API Guidelines | Best practices for API design |
| Rust Edition Guide | Edition migration guide |
| rustup Documentation | Toolchain manager |
| Cargo Book | Package manager documentation |
Frameworks Used
| Resource | Description |
|---|---|
| Axum Documentation | Web framework |
| Tokio Documentation | Async runtime |
| SQLx Documentation | Async SQL toolkit |
| Serde Documentation | Serialization framework |
| Tower Documentation | Middleware framework |
| Tracing Documentation | Application instrumentation |
| Clap Documentation | Command-line parser |
| Reqwest Documentation | HTTP client |
| Utoipa Documentation | OpenAPI generation |
Testing & Quality
| Resource | Description |
|---|---|
| Rust Testing | Testing in Rust |
| cargo-tarpaulin | Code coverage tool |
| cargo-deny | Dependency linting |
| Clippy Lints | Lint reference |
| Rustfmt Configuration | Formatter options |
Security
HashiCorp Vault
| Resource | Description |
|---|---|
| Vault Documentation | Official documentation |
| Vault Getting Started | Beginner tutorials |
| KV Secrets Engine v2 | Key-value secrets |
| AppRole Auth Method | Application authentication |
| Vault Security Model | Security architecture |
| Vault Production Hardening | Production best practices |
System Security
| Resource | Description |
|---|---|
| CIS Benchmarks | Security configuration guides |
| OWASP API Security Top 10 | API security risks |
| Mozilla SSL Configuration | TLS configuration generator |
| SSH Hardening Guide | SSH security |
| Fail2ban Documentation | Intrusion prevention |
Cryptography
| Resource | Description |
|---|---|
| RustCrypto | Pure Rust crypto implementations |
| ring Documentation | Crypto library |
| Argon2 Specification | Password hashing |
APIs & Integrations
AI & Language Models
| Resource | Description |
|---|---|
| OpenAI API Reference | OpenAI API docs |
| Ollama API | Ollama REST API |
| LLM Tokenization | Understanding tokenizers |
Communication
| Resource | Description |
|---|---|
| WhatsApp Business API | WhatsApp Cloud API |
| WhatsApp Webhooks | Webhook setup |
| Resource | Description |
|---|---|
| Proton Bridge | Proton Mail IMAP/SMTP bridge |
| Gmail IMAP | Gmail IMAP/SMTP settings |
| Outlook IMAP | Outlook IMAP/SMTP settings |
| IMAP RFC 3501 | IMAP protocol |
| SMTP RFC 5321 | SMTP protocol |
| XOAUTH2 SASL | OAuth2 for IMAP/SMTP |
Calendar
| Resource | Description |
|---|---|
| CalDAV RFC 4791 | CalDAV protocol |
| iCalendar RFC 5545 | iCalendar format |
| Baïkal Server | CalDAV/CardDAV server |
Weather
| Resource | Description |
|---|---|
| Open-Meteo API | Free weather API |
Infrastructure
Docker
| Resource | Description |
|---|---|
| Docker Documentation | Official docs |
| Docker Compose | Multi-container apps |
| Docker on Raspberry Pi | ARM installation |
Reverse Proxy
| Resource | Description |
|---|---|
| Traefik Documentation | Cloud-native proxy |
| Let’s Encrypt | Free TLS certificates |
| Nginx Documentation | Web server/proxy |
Monitoring
| Resource | Description |
|---|---|
| Prometheus Documentation | Metrics collection |
| Grafana Documentation | Visualization |
| Loki Documentation | Log aggregation |
| OpenTelemetry | Observability framework |
Databases
| Resource | Description |
|---|---|
| PostgreSQL 17 Documentation | Relational database |
| pgvector | Vector similarity search for PostgreSQL |
Development Tools
VS Code
| Resource | Description |
|---|---|
| rust-analyzer | Rust language server |
| CodeLLDB | Debugger |
| Even Better TOML | TOML support |
GitHub
| Resource | Description |
|---|---|
| GitHub Actions | CI/CD platform |
| Release Please | Release automation |
| GitHub Pages | Static site hosting |
Documentation
| Resource | Description |
|---|---|
| mdBook Documentation | Documentation tool |
| rustdoc Book | Rust documentation |
Standards & Specifications
| Resource | Description |
|---|---|
| OpenAPI Specification | API description format |
| JSON Schema | JSON validation |
| Semantic Versioning | Version numbering |
| Keep a Changelog | Changelog format |
| Conventional Commits | Commit message format |
Community
| Resource | Description |
|---|---|
| Rust Users Forum | Community forum |
| Rust Discord | Chat community |
| This Week in Rust | Weekly newsletter |
| Raspberry Pi Forums | Hardware community |
💡 Tip: Many of these resources are updated regularly. Always check for the latest version of documentation when implementing features.