curl.exe instead of curl if needed. Checksums and full instructions are also included in the [release](https://github.com/davemessew/AgentFlux/releases/tag/v0.3.0).
| Agents Tasks, models and recurring jobs in one place. |
Knowledge base Search documents and processed content locally. |
![]() |
![]() |
http://host.docker.internal:11434 |
| LM Studio / OpenAI-compatible | http://host.docker.internal:1234/v1 |
| vLLM | http://host.docker.internal:8000/v1 |
Adjust the port and model ID for your server. The model server must accept connections from the container.
## Operations and data
~~~sh
docker compose ps # Status and healthcheck
docker compose logs -f # View server output
docker compose stop # Stop
docker compose up -d --wait # Start again
~~~
Workflows, documents, credentials and run logs stay in the named agentflux-data volume. Reports are stored in its `outbox` directory by default. The separate `agentflux-models` volume caches speech assets. Replacing the containers does not delete these volumes. Back up the entire volume including .vault-key; docker compose down -v deletes the volume.
> [!IMPORTANT]
> The supplied configuration binds port 4310 to localhost. AgentFlux has no login and is designed for a single user. Shared or public access requires an access-control layer and suitable network configuration.
Cloud model calls and external HTTP POST steps require approval in Settings and in the workflow. HTTP GET requests can send information in URLs and headers. Optional redaction uses rules and may miss sensitive information. See the [installation guide](docs/installation.md#data-and-limits) and [operations guide](docs/operations.md).
## Documentation and development
| Start here | Contents |
| :--- | :--- |
| [Docker release](https://github.com/davemessew/AgentFlux/releases/latest) | Prebuilt image, Compose file, source code and SHA-256 checksums |
| [Install the release](docs/docker-release.md) | Download, verify, start and update |
| [Installation and models](docs/installation.md) | Docker, native installation and model connections |
| [Workflows and agents](docs/workflows.md) | Editor, steps, templates, learnings and skills |
| [Operations and configuration](docs/operations.md) | Environment variables, import folders, backups and programs |
~~~text
src/ Web interface and visual editor
server/ API, agents, execution and SQLite storage
shared/ Domain types, workflow rules and templates
services/ Local speech recognition
tests/ Contract and media checks
examples/ Sample local program export
scripts/ Docker release checks
docs/ Usage, operations and screenshots
~~~
For local development: Node.js 24+, pnpm 11.25.0, pnpm install --frozen-lockfile, then pnpm dev. Run pnpm test for focused checks; pnpm build also checks TypeScript.
Run the Docker check after building:
~~~sh
docker build -t agentflux:0.3.0 .
node scripts/smoke-docker.mjs agentflux:0.3.0
~~~
The check uses its own container and volume. It covers the API, built interface, an example run and data persistence when replacing the container.
## Licence
[Apache License 2.0](LICENSE). Bundled dependencies and fonts retain their respective licences.