Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/SITE-HANDBOOK.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,10 +268,16 @@ python tools\render_pages.py --lastmod $lastmod --check
git diff --check
```

Run the normal push gate from the selected Build checkout through
Run the normal fast push gate from the selected Build checkout through
`python -B -m emule_workspace local-check --repo <selected-pages-checkout>
--stage push`. The manager checks renderer capabilities, performs source drift
checks without writes, and stages into a unique inherited
--stage push`. It runs applicable fast source checks, including privacy and
hygiene, against clean selected sources. A pushed checkpoint still requires
full public-presence staging proof before merge and publication.

The parent schedules `python -B -m emule_workspace local-check
--repo <selected-pages-checkout> --stage full` under the shared heavy-validation
lock. This checks renderer capabilities, verifies clean source identity and
generated-output drift without source writes, and stages into a unique inherited
`EMULEBB_WORKSPACE_OUTPUT_ROOT/artifacts/public-presence/<run>/site` child.
It validates the staged site, documentation links and stable installer checksum.
Do not precreate that `site` child or use source-local `.local` output. Explicit
Expand Down
6 changes: 3 additions & 3 deletions faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"name": "How do I open the browser console?",
"acceptedAnswer": {
"@type": "Answer",
"text": "The implicit native first launch creates a private profile and prints the API key once. Open http://127.0.0.1:4711/ and enter that key. Keep all packaged WebUI files beside the client; existing profiles keep their existing key."
"text": "Direct daemon launches keep the profile beside the executable. Installed and container launchers use the writable profile documented in their package notes. Open http://127.0.0.1:20017/ and use rest.api_key from emulebb-rust-settings.toml. Ready packages provide the shared starter change_me_123change_me_123change_me_123; replace it before remote exposure. Existing profiles retain their own key. Keep the complete packaged WebUI layout."
}
},
{
Expand Down Expand Up @@ -154,8 +154,8 @@ <h2>Which package should I download?</h2>
</article>
<article>
<h2>How do I open the browser console?</h2>
<p>The implicit native first launch creates a private profile and prints the API key once. Open http://127.0.0.1:4711/ and enter that key. Keep all packaged WebUI files beside the client; existing profiles keep their existing key.</p>
<a href="https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-GETTING-STARTED/">Read more: First-launch guide</a>
<p>Direct daemon launches keep the profile beside the executable. Installed and container launchers use the writable profile documented in their package notes. Open http://127.0.0.1:20017/ and use rest.api_key from emulebb-rust-settings.toml. Ready packages provide the shared starter change_me_123change_me_123change_me_123; replace it before remote exposure. Existing profiles retain their own key. Keep the complete packaged WebUI layout.</p>
<a href="https://emulebb.github.io/emulebb-tooling/products/emulebb-rust/reference/GUIDE-DOWNLOADS-PLATFORMS/">Read more: Package and startup notes</a>
</article>
<article>
<h2>How do networking and interface settings work?</h2>
Expand Down
2 changes: 1 addition & 1 deletion tools/render_pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -884,7 +884,7 @@ def prepare_english_faq(routes: dict[str, Any]) -> None:
"items": [
faq_item("What is eMuleBB Rust?", "A headless IPv4 eD2K/Kad client with a packaged browser console and authenticated REST API. It manages search, transfers and monitored shared folders.", "First-launch guide", user["url"]),
faq_item("Which package should I download?", "Choose the matching Windows, Linux or macOS package. Linux also has static-musl archives and container images. Android bundles are experimental developer artifacts, not an APK or a supported Android app.", "Platforms and downloads", user["downloads_url"]),
faq_item("How do I open the browser console?", "The implicit native first launch creates a private profile and prints the API key once. Open http://127.0.0.1:4711/ and enter that key. Keep all packaged WebUI files beside the client; existing profiles keep their existing key.", "First-launch guide", user["url"]),
faq_item("How do I open the browser console?", "Direct daemon launches keep the profile beside the executable. Installed and container launchers use the writable profile documented in their package notes. Open http://127.0.0.1:20017/ and use rest.api_key from emulebb-rust-settings.toml. Ready packages provide the shared starter change_me_123change_me_123change_me_123; replace it before remote exposure. Existing profiles retain their own key. Keep the complete packaged WebUI layout.", "Package and startup notes", user["downloads_url"]),
faq_item("How do networking and interface settings work?", "Review server/Kad status, the chosen P2P interface and TCP/UDP reachability. REST control and P2P routing are separate; a loopback console does not imply offline networking or guarantee VPN safety.", "Network setup", user["url"]),
faq_item("How do I share files?", "Add deliberately chosen folder roots, review ignore patterns, and let recursive scanning and hashing finish. Sharing is managed as monitored folder trees. Add roots gradually rather than exposing an entire home directory.", "Sharing workflow", user["url"]),
faq_item("Can I automate the client?", "Yes. Authenticated /api/v1 requests use the X-API-Key header and the documented REST contract. The beta API can change; protect credentials and use the API consumer guide for requests and error handling.", "REST API guide", develop["api_url"]),
Expand Down