Skip to content

Name the amuleapi fields behind the remote-folder and local-only rules - #259

Merged
ngosang merged 2 commits into
amule-org:mainfrom
ngosang:docs/remote-allowed-roots
Nov 2, 2026
Merged

ngosang merged 2 commits into
amule-org:mainfrom
ngosang:docs/remote-allowed-roots

Conversation

@ngosang

@ngosang ngosang commented Nov 2, 2026

Copy link
Copy Markdown
Member

Closes #253.

Most of #253 was already covered by #255. I checked each point again against the code at the 3.2.0 tag. The only gap was the amuleapi field names.

Point in the issue Status
1. Allow-list for remote folder changes
allowed-remote-dirs.dat in config files, directories.md, amuled.md, troubleshooting Already done
Preferences → Remote Controls: Folders remote clients may use Already done
amulegui: the read-only Folders the daemon allows remote changes in list, and refused changes Already done (amulegui.md and preferences.md)
Web UI: read-only Allowed remote folders, the Folder not allowed error Already done
amuleapi: 403 path_not_allowed Already done
amuleapi: the read-only directories.allowed_remote_roots field Added in this PR
2. Settings that can no longer be changed remotely
amule.conf (FFProbePath, OSDirectory, FollowSymlinksInShares), amulegui.md, preferences.md Already done
amuleapi: which fields answer 400 read_only_field Added in this PR
3. amuleweb guest access (--allow-guest / --deny-guest, AllowGuest, GuestPassword, UseLowRightsUser, troubleshooting) Already done
4. Downloads only over http and https (server-met.md, nodes-dat.md, file-formats/index.md, IPFilterURL) Already done. The ftp://localhost/fastservers.met example is gone

The only change is in amuleapi/index.md, under Security Model:

  • The allow-list is exposed read-only as the directories.allowed_remote_roots preference (PrefAccess::ReadOnly in src/webapi/PrefsSchema.cpp).
  • The three daemon-local fields that answer 400 read_only_field are files.ffprobe_path, online_signature.directory and directories.follow_symlinks (PrefAccess::DaemonLocal).

npm run build -- --locale en builds with no errors and no broken links.

Document the read-only directories.allowed_remote_roots preference and the three daemon-local fields that answer 400 read_only_field. The rest of amule-org#253 was already documented.

Closes amule-org#253
@ngosang
ngosang merged commit 05e4cd2 into amule-org:main Nov 2, 2026
2 checks passed
@ngosang
ngosang deleted the docs/remote-allowed-roots branch November 2, 2026 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: cover the 3.2.0 remote-control and download changes

1 participant