c/quicproquo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: rename quicproquo → quicprochat in docs, Docker, CI, and packaging

Browse Source 
Rename all project references from quicproquo/qpq to quicprochat/qpc
across documentation, Docker configuration, CI workflows, packaging
scripts, operational configs, and build tooling.

- Docker: crate paths, binary names, user/group, data dirs, env vars
- CI: workflow crate references, binary names, artifact names
- Docs: all markdown files under docs/, SDK READMEs, book.toml
- Packaging: OpenWrt Makefile, init script, UCI config (file renames)
- Scripts: justfile, dev-shell, screenshot, cross-compile, ai_team
- Operations: Prometheus config, alert rules, Grafana dashboard
- Config: .env.example (QPQ_* → QPC_*), CODEOWNERS paths
- Top-level: README, CONTRIBUTING, ROADMAP, CLAUDE.md
This commit is contained in:
Christian Nennemann
2026-03-07 18:46:43 +01:00
parent a710037dde
commit 2e081ead8e
179 changed files with 1645 additions and 1645 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/openwrt.md
View File

@@ -1,6 +1,6 @@
# OpenWrt Deployment Guide
Run quicproquo on OpenWrt routers for mesh-capable, always-on encrypted messaging at the network edge.
Run quicprochat on OpenWrt routers for mesh-capable, always-on encrypted messaging at the network edge.
## Supported Targets
@@ -44,10 +44,10 @@ CARGO_PROFILE_RELEASE_OPT_LEVEL=s \
CARGO_PROFILE_RELEASE_LTO=true \
CARGO_PROFILE_RELEASE_CODEGEN_UNITS=1 \
CARGO_PROFILE_RELEASE_STRIP=symbols \
cargo zigbuild --release --target x86_64-unknown-linux-musl --bin qpq-server
cargo zigbuild --release --target x86_64-unknown-linux-musl --bin qpc-server
```
The binary lands at `target/<triple>/release/qpq-server`. Target size: under 5 MB.
The binary lands at `target/<triple>/release/qpc-server`. Target size: under 5 MB.
## OpenWrt Package Installation
@@ -55,14 +55,14 @@ The binary lands at `target/<triple>/release/qpq-server`. Target size: under 5 M
```bash
# Copy binary to router
scp target/aarch64-unknown-linux-musl/release/qpq-server root@router:/usr/bin/
scp target/aarch64-unknown-linux-musl/release/qpc-server root@router:/usr/bin/
# Copy init script and config
scp packaging/openwrt/files/quicproquo.init root@router:/etc/init.d/quicproquo
scp packaging/openwrt/files/quicproquo.uci root@router:/etc/config/quicproquo
scp packaging/openwrt/files/quicprochat.init root@router:/etc/init.d/quicprochat
scp packaging/openwrt/files/quicprochat.uci root@router:/etc/config/quicprochat
# Enable and start
ssh root@router 'chmod +x /etc/init.d/quicproquo && /etc/init.d/quicproquo enable && /etc/init.d/quicproquo start'
ssh root@router 'chmod +x /etc/init.d/quicprochat && /etc/init.d/quicprochat enable && /etc/init.d/quicprochat start'
```
### Option 2: opkg package feed
@@ -71,28 +71,28 @@ Add the feed to your OpenWrt build system:
```bash
# In your OpenWrt buildroot, add to feeds.conf:
echo "src-link quicproquo /path/to/quicproquo/packaging/openwrt" >> feeds.conf
echo "src-link quicprochat /path/to/quicprochat/packaging/openwrt" >> feeds.conf
# Update and install
./scripts/feeds update quicproquo
./scripts/feeds install quicproquo
./scripts/feeds update quicprochat
./scripts/feeds install quicprochat
# Select in menuconfig: Network -> quicproquo
# Select in menuconfig: Network -> quicprochat
make menuconfig
make package/quicproquo/compile V=s
make package/quicprochat/compile V=s
```
## Configuration
The server is configured via UCI at `/etc/config/quicproquo`:
The server is configured via UCI at `/etc/config/quicprochat`:
```
config server 'server'
option listen '0.0.0.0:7000'
option data_dir '/var/lib/quicproquo'
option data_dir '/var/lib/quicprochat'
option log_level 'info'
option tls_cert '/var/lib/quicproquo/server-cert.der'
option tls_key '/var/lib/quicproquo/server-key.der'
option tls_cert '/var/lib/quicprochat/server-cert.der'
option tls_key '/var/lib/quicprochat/server-key.der'
option production '1'
```
@@ -101,7 +101,7 @@ config server 'server'
| Option | Default | Description |
|--------------|------------------------------------------|----------------------------------|
| `listen` | `0.0.0.0:7000` | QUIC listen address |
| `data_dir` | `/var/lib/quicproquo` | Persistent data directory |
| `data_dir` | `/var/lib/quicprochat` | Persistent data directory |
| `log_level` | `info` | RUST_LOG filter |
| `tls_cert` | `<data_dir>/server-cert.der` | TLS certificate path (DER) |
| `tls_key` | `<data_dir>/server-key.der` | TLS private key path (DER) |
@@ -111,15 +111,15 @@ config server 'server'
```bash
# Start / stop / restart
/etc/init.d/quicproquo start
/etc/init.d/quicproquo stop
/etc/init.d/quicproquo restart
/etc/init.d/quicprochat start
/etc/init.d/quicprochat stop
/etc/init.d/quicprochat restart
# Enable at boot
/etc/init.d/quicproquo enable
/etc/init.d/quicprochat enable
# View logs
logread -e quicproquo
logread -e quicprochat
```
## Binary Size Optimization