diff options
Diffstat (limited to 'README.txt')
| -rw-r--r-- | README.txt | 26 |
1 files changed, 15 insertions, 11 deletions
@@ -22,8 +22,11 @@ STACK GETTING STARTED Install Rust through rustup, Podman, Git, and GnuPG on a Linux development - machine. The pinned toolchain includes rustfmt, Clippy, and the static - x86_64 Linux target. + machine. Chat builds also need a GCC-compatible C compiler, Linux UAPI + headers, libclang, pkg-config, make, Perl, curl, tar, and OpenSSL 3.5+ + development libraries for native workspace checks. The pinned toolchain + includes rustfmt, Clippy, and the static x86_64 Linux target. + See docs/CHAT-PRODUCTION.txt for the native/WASI release build. From this directory: @@ -31,7 +34,7 @@ GETTING STARTED cargo stack status cargo stack down - Browse http://localhost:8080, /git/, and /search/. + Browse http://localhost:8080, /git/, /search/, and http://chat.localhost:8080/. A fresh checkout generates a private .env automatically. Local mode binds only loopback and does not request public certificates. @@ -52,7 +55,7 @@ DEVELOPMENT AND PRODUCTION and exports. Generated TLS private keys are runtime data under var/. .env, var/, .tools/, target/, bin/, and dist/ are excluded from Git. - The three existing services are Caddy, cgit, and SearXNG. The management + The four services are Caddy, cgit, SearXNG, and the Rust chat server. The management command is Rust. SearXNG and the cgit container's upstream supervisor retain their third-party Python implementation. No first-party Python is needed. @@ -75,15 +78,16 @@ CHECKS AND LICENSES Detailed manual backup, recovery, deployment, and host setup instructions are in docs/OPERATIONS.txt. Read docs/POLICY.txt before changing conventions. -EXPERIMENTAL CHAT BRANCH +EXPERIMENTAL CHAT - feature/private-chat contains a local Rust/WASI chat application. Start with + main includes the experimental Rust/WASI chat application. Start with docs/CHAT-APPLICATION.txt for setup, protected files, tests, backup/restore, source licensing, and security limitations. cargo stack chat --init appends chat configuration to the existing single root .env; cargo stack chat runs - the local service. This does not deploy or enable production chat. + the direct local service. docs/CHAT-PRODUCTION.txt describes its packaged + HTTPS gateway, release deployment, production owner setup, and recovery. + Building a release does not activate production. - SQLite snapshots now use the bundled SQLite C library. Portable stack - release builds consequently also require a musl C compiler on the development - machine, in addition to the Rust musl target. Runtime binaries remain static; - no new compiler is required on the VPS. + SQLite snapshots use the bundled SQLite C library. Release scripts build + static OpenSSL against hash-verified musl headers and the Rust musl target. + Runtime binaries remain static; no compiler is required on the VPS. |