nexoralnexoral/AxioDB/Docker/AGENTS.md

AxioDB / Docker

AGENTS.md35 starsChanged 9 days agoMITView on GitHub

Global rules live in ../AGENTS.md. This file only adds Docker/ specifics — read the root first. Role — ships the compiled core (lib/) plus three surfaces in one container: HTTP GUI/API 27018, TCP AxioDBCloud 27019, opt-in MCP server 27020. Image theankansaha/axiodb. Container runtime runs on Node 23 (node:23-alpine), while base engine maintains Node ≥20 compatibility. The Dockerfile does COPY lib/ package*.json Scripts/ — none of which live inside Docker/ in the repo. CI copies them in first: So a local…

Installs packages

Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,843 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository12 other files it gives its agents.
- AGENTS.mdAGENTS.md
- cli/AGENTS.mdAGENTS.md
- Document/AGENTS.mdAGENTS.md
- electron/AGENTS.mdAGENTS.md
- Email/AGENTS.mdAGENTS.md
- GUI/AGENTS.mdAGENTS.md
- Scripts/AGENTS.mdAGENTS.md
- source/AGENTS.mdAGENTS.md
- Test/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- skillSkill

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Keep USER axiodb (post-install) and the exec node runner.js CMD so SIGTERM reaches PID 1 for graceful shutdown.
line 48

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

AGENTS.md

Docker/ — Container Image (Agent Instructions)

Global rules live in ../AGENTS.md. This file only adds Docker/ specifics — read the root first.

Role — ships the compiled core (lib/) plus three surfaces in one container: HTTP GUI/API 27018, TCP AxioDBCloud 27019, opt-in MCP server 27020. Image theankansaha/axiodb. Container runtime runs on Node 23 (node:23-alpine), while base engine maintains Node ≥20 compatibility.

Layout

Dockerfile        node:23-alpine (Node 23 container runtime); drops to non-root `axiodb`; HEALTHCHECK → healthcheck.js
runner.js         entrypoint: maps env → AxioDB options (including MCP), validates combos, UV_THREADPOOL_SIZE
healthcheck.js    probes GUI /health + a real TCP PING/PONG round-trip
README.md         user-facing docs + version badge

Build context is assembled by CI

The Dockerfile does COPY lib/ package*.json Scripts/ — none of which live inside Docker/ in the repo. CI copies them in first:

npm run build && (cd GUI && npm install && npm run build) \
  && mv GUI/AxioControl lib/server/public
mv lib/ Docker/ && cp package*.json Docker/ && cp -r Scripts/ Docker/
docker build -t theankansaha/axiodb Docker/

So a local docker build Docker/ only works after those mv/cp steps. Don't commit Docker/lib/, Docker/package.json, or Docker/Scripts/.

Env contract (must match `runner.js` + README table)

Var	Default	Notes
`AXIODB_GUI`	`true`	HTTP control server / GUI on 27018
`AXIODB_HTTP`	mirrors `AXIODB_GUI`	`GUI=true` + `HTTP=false` is a hard error
`AXIODB_TCP`	`true`	27019
`AXIODB_TCP_AUTH_ENABLED`	`true`	shared RBAC accounts with the GUI
`AXIODB_ADMIN_PASSWORD`	(none)	required when TCP auth on and HTTP off, else the container refuses to start
`AXIODB_TLS` / `_CERT_PATH` / `_KEY_PATH`	`false` / —	TLS on 27019
`AXIODB_ROOT_NAME`	`AxioDB`	root DB folder under the data volume
`AXIODB_CUSTOM_PATH`	cwd	storage path in-container
`AXIODB_MCP` / `AXIODB_MCP_PORT`	`false` / `27020`	opt-in MCP
`AXIODB_CACHE`, `AXIODB_CACHE_MIN_TTL`, `AXIODB_CACHE_MAX_TTL`, `AXIODB_CACHE_CLEARUP`	core defaults	supported in `runner.js`; keep README in sync if exposed

Hard rules

Any new core option surfaced as an env var must be added to runner.js and the README table in the same change.
AXIODB_MCP in Docker delegates to the native MCP server in AxioDB core (options.MCP: true). Zero native dependencies.
Keep USER axiodb (post-install) and the exec node runner.js CMD so SIGTERM reaches PID 1 for graceful shutdown.
Destructive MCP tools (delete/update/drop/reset) must keep their elicitation confirmation and destructiveHint annotations.
Ports are not env-configurable — remap with -p host:27018 / -p host:27019.

Version sync (this folder)

Docker/README.md → shield badge badge/AxioDB-<version> (handled by Scripts/versionController.sh).

Done for this folder

runner.js and the README env table agree
MCP tools still confirmed on destructive paths; MCP SDK not leaked into package.json
Image builds from the CI-assembled context and HEALTHCHECK passes
README badge version matches root when releasing

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free