comply with SignPath terms
Massimo Melina committed
Feb 5, 2026 at 17:59 UTC
c898e7792744f73007704d7da6852dfa202bd928
2 files changed
+18
AGENTS.md
+8
@@ -3,6 +3,14 @@
3
## Project Structure & Module Organization
4
Core server logic sits in `src/` (TypeScript, Koa middleware, plugins). Shared React packages live under the workspace folders `frontend/`, `admin/`, `shared/`, and `mui-grid-form/`. Runtime assets (icons, central metadata) are in the repo root; packaged plugins reside in `plugins/`. Tests use `tests/` for Node-based suites and `e2e/` + `playwright.config.ts` for UI regression coverage. Build outputs land in `dist/`; avoid committing its contents manually.
5
6
+## Docs Map
7
+- `README.md` — overview, installation, and general usage.
8
+- `config.md` — configuration keys and where config files are stored (includes `server_code` for backend scripting).
9
+- `dev.md` — build, dev environment, tests, and coding guidelines.
10
+- `dev-plugins.md` — plugin development and API reference (backend and frontend APIs).
11
+- `SECURITY.md` — security policy and reporting.
12
+- Wiki — some topics are documented only on the project wiki.
13
+
14
## Build, Test, and Development Commands
15
- `npm run watch-server` — start the TypeScript server with hot reload (set `FRONTEND_PROXY`/`ADMIN_PROXY` when pairing with dev UIs).
16
- `npm run watch-server-full` — boot both React apps plus the API server for integrated development.
README.md
+10
@@ -92,6 +92,8 @@ Troubleshooting
92
By default, HFS does not require a login when you access the *Admin-panel* from localhost.
93
If you don't like this behavior, disable it in the Admin-panel or enter this console command `config localhost_admin false`.
94
95
+To uninstall, remove the files you unzipped and the configuration/data directory (see `config.md` for the location).
96
+
97
### Other systems
98
99
If you can't or don't want to run our binary versions, you can try this:
@@ -171,6 +173,14 @@ There are several ways to contribute
173
174
A plugin can change the look (a theme), and/or introduce a new functionality.
175
176
+## Code Signing Policy
177
+
178
+Free code signing 🙏 provided by SignPath.io, certificate by [SignPath Foundation](https://signpath.org).
179
+
180
+Author/Reviewer/Approver: Massimo Melina.
181
+
182
+Privacy: Update checks are opt-out; other outbound connections are user-triggered.
183
+
184
## More
185
186
- [Additional information (Wiki)](https://github.com/rejetto/hfs/wiki)