Skip to content

Commit dc13a81

Browse files
committed
docs: update Docker examples and remove deferred ADR references
1 parent 2c0df6f commit dc13a81

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,19 @@ warpshift trace parse --file trace.txt
127127
### Docker Compose One-Off Commands
128128

129129
```bash
130-
# Validate config inside the container
131-
docker compose run --rm warpshift config validate
132-
133-
# Import identity
134-
docker compose run --rm warpshift identity import --input /home/warpshift/configs/warpshift.identity.json
135-
136-
# Export WireGuard profile
137-
docker compose run --rm warpshift wireguard export
130+
# Validate the mounted local config inside the container
131+
docker compose run --rm warpshift config validate \
132+
--config /home/warpshift/configs/warpshift.local.toml
133+
134+
# Import identity from the read-only mount into writable state
135+
docker compose run --rm warpshift identity import \
136+
--input /home/warpshift/configs/warpshift.identity.json \
137+
--store /home/warpshift/state/warpshift.identity.json
138+
139+
# Export WireGuard profile from writable state
140+
docker compose run --rm warpshift wireguard export \
141+
--identity /home/warpshift/state/warpshift.identity.json \
142+
--output /home/warpshift/state/warpshift.wg.conf
138143
```
139144

140145
## Configuration
@@ -204,13 +209,13 @@ WarpShift-TUI/
204209

205210
WarpShift-TUI is designed for **local, private-use operation**. Key safety features:
206211

207-
- **Paired Consent Gates** — Advanced workflows (account registration, streaming rotation, user-owned WARP+ license binding) require both a feature flag and a matching consent flag in the `[safety]` configuration section. Both must be `true` for the workflow to activate. See [`docs/architecture/ADR-001-safety-consent-architecture.md`](docs/architecture/ADR-001-safety-consent-architecture.md) for details.
212+
- **Paired Consent Gates** — Advanced workflows (account registration, streaming rotation, user-owned WARP+ license binding) require both a feature flag and a matching consent flag in the `[safety]` configuration section. Both must be `true` for the workflow to activate.
208213
- **Local-First** — No telemetry, no remote analytics. All state is stored locally.
209214
- **Secret-Safe Defaults** — Identity files, WireGuard configs, and local config overrides are git-ignored by default.
210215
- **Rate Limiting & Allowlists** — Proxy listeners default to localhost-only with per-client connection budgets.
211216
- **Non-Root Docker** — Container runs as a dedicated `warpshift` user with resource limits.
212-
- **DPI Evasion (Not Implemented)** — The `dpi_evasion` config flags exist but no runtime DPI evasion logic is active. See [`docs/architecture/ADR-002-dpi-evasion-deferred.md`](docs/architecture/ADR-002-dpi-evasion-deferred.md).
213-
- **TLS Proxy Mode (Not Implemented)** — The `tls_mode` config field exists but only `"disabled"` has an effect. See [`docs/architecture/ADR-003-tls-proxy-mode-deferred.md`](docs/architecture/ADR-003-tls-proxy-mode-deferred.md).
217+
- **DPI Evasion (Not Implemented)** — The `dpi_evasion` config flags exist for compatibility, but no runtime DPI evasion logic is active.
218+
- **TLS Proxy Mode (Not Implemented)** — The `tls_mode` config field exists but only `"disabled"` has an effect.
214219

215220
> **Important:** This tool is intended for managing WARP connections on accounts, licenses, and networks you own or are authorized to use. It does not implement third-party WARP+ generation, referral farming, credential sharing, mass account registration, provider-specific streaming bypass, or DPI evasion. Users are responsible for compliance with Cloudflare's terms of service.
216221
@@ -230,14 +235,9 @@ See [SUPPORT.md](SUPPORT.md) for getting help and filing bug reports.
230235

231236
See [SECURITY.md](SECURITY.md) for the vulnerability reporting policy.
232237

233-
## Architecture Decisions
234-
235-
Architecture decision records are located in [`docs/architecture/`](docs/architecture/):
238+
## Architecture Notes
236239

237-
- [ADR-001: Safety and Consent Gate Architecture](docs/architecture/ADR-001-safety-consent-architecture.md) — How paired consent flags protect sensitive workflows.
238-
- [ADR-002: DPI Evasion — Deferred Scope](docs/architecture/ADR-002-dpi-evasion-deferred.md) — Why DPI evasion config exists but runtime is not implemented.
239-
- [ADR-003: TLS Proxy Mode — Deferred Scope](docs/architecture/ADR-003-tls-proxy-mode-deferred.md) — Why `tls_mode` is parsed but only `"disabled"` has effect.
240-
- [ADR-004: Bubble Tea v2 Migration — Deferred](docs/architecture/ADR-004-bubbletea-v2-migration-deferred.md) — Why the TUI remains on Bubble Tea v1.
240+
Architecture decision records are not currently maintained as standalone files. Safety gates, deferred DPI evasion, deferred TLS proxy mode, and the Bubble Tea v1 runtime model are documented in this README and in the annotated example config.
241241

242242
## Disclaimer
243243

0 commit comments

Comments
 (0)