docs: document data locations and resource limits - #89
Draft
sanity wants to merge 2 commits into
Draft
Conversation
Users ask where Freenet keeps its data and how to cap what the peer uses, and the answer wasn't on the site. The only place a data path appeared was the uninstall guide, in the context of deleting it. Adds /configuration/ with the per-OS data, config, and log paths, how to edit config.toml and restart, and the resource settings that matter (hosting storage budget, module cache, blocking threads, connection counts, bandwidth limits) with their defaults and an example config for a light-touch peer. Linked from the FAQ and quickstart troubleshooting. Values verified against freenet-core main (crates/core/src/config.rs, ring/hosting/cache.rs, tracing/tracer.rs) as of 0.2.112. [AI-assisted - Claude] Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Nt3ybmxRb7F3vVfpANnZQ5
[AI-assisted - Claude] Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Nt3ybmxRb7F3vVfpANnZQ5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
A user on Matrix asked: "Where is the data stored on my mac and how can I limit how much resources I want to dedicate to the network?"
Neither answer is on the site. The only place a data path appears is the uninstall guide, in the context of deleting it, and nothing documents
config.tomlor any resource setting.Approach
New
/configuration/page with:config.toml, restart. Includes the two failure modes worth warning about (a hand-written partial file fails to parse and the peer won't start; deletingconfig.tomlregenerates it without touching data or keys).max-hosting-storage,hosting-disk-pct,max-hosting-disk,module-cache-budget-bytes,max_blocking_threads,min/max-number-of-connections,total_bandwidth_limit,bandwidth_limit.Linked from the FAQ (new entry) and the quickstart troubleshooting section. No menu entry, matching how
/uninstall/is surfaced.Verification
Every path, key name, and default was read out of freenet-core
mainrather than recalled:crates/core/src/config.rs(ProjectDirs::from("", "The Freenet Project Inc", "Freenet")) andcrates/core/src/tracing/tracer.rs::get_log_dir. The macOS path matches the one already in the uninstall guide.crates/core/src/ring/hosting/cache.rs(RAM/8 clamped 128 MiB–1 GiB; disk pct 0.5; 32 GiB cap),crates/core/src/ring.rs(min 25 / max 200 connections),config.rs(3 MB/s streaming cap, 2x cores blocking threads).Configserde attributes, which is what the file is written from, not the CLI arg names (they differ: the file usestotal_bandwidth_limit, the flag is--total-bandwidth-limit)..apprunsfreenet service run-wrapper(tray, with a Restart item), and both the launchd wrapper and the systemd unit invoke plainfreenet network, soconfig.tomlreally is the only channel for a service install.hugobuilds clean; both cross-links resolve in the rendered output.Draft because the wording is worth a pass before it goes live.
[AI-assisted - Claude]
🤖 Generated with Claude Code
https://claude.ai/code/session_01Nt3ybmxRb7F3vVfpANnZQ5