Signed-off-by: stroblme <stroblme@posteo.de>
This commit is contained in:
2026-08-24 19:06:54 +02:00
parent 47e513b658
commit 0926dabb99
3 changed files with 21 additions and 34 deletions
+18 -22
View File
@@ -1,16 +1,16 @@
# Fluksio App
Fluksio has the goal to build a revolutionary system to tackle any sort of automation challenge.
Fluksio is a node-based automation software that brings trust and reliability to your flow.
It just works and looks good.
The core of Fluksio: a node-based, test-driven automation software built to scale. This
repo holds the FastAPI backend, the flow engine, and the dashboard SPA. It is served on
`app.${DOMAIN}` (SPA) and `api.${DOMAIN}` (API); the marketing site lives in the sibling
`index` repo.
`app.${DOMAIN}` (SPA) and `api.${DOMAIN}` (API)
## Layout
```text
backend/ FastAPI + SQLModel + Alembic + SQLite — the `fluksio` distribution
backend/ FastAPI + SQLModel + Alembic + SQLite
fluksio/flow/ the flow engine (nodes, pipeline, state backends, controller)
fluksio/cli.py `fluksio serve` / `enroll` / `worker`
worker/ the `fluksio-worker` distribution: the agent and the node runner
@@ -22,19 +22,23 @@ scripts/ generate-client.sh, test.sh
## Install without Docker
Get started quickly by running
```sh
pip install fluksio
fluksio serve # ~/.fluksio, SQLite, prints an admin password once
fluksio enroll <code> --portal https://hub.fluksio.com # watch it from the portal
fluksio serve
```
Nothing else has to be running. `--data-dir` puts the installation somewhere else —
worth it on a cluster, where `$HOME` is often a network filesystem SQLite cannot use.
`git` is not required but is worth having: flows are files either way, and it is what
turns each save into a commit.
The dashboard is served by the portal, so a machine with no inbound route is reached
without opening a port: it dials out.
Then, head over to [fluksio.com](https://fluksio.com), sign up and add a new installation.
Using the code provided, run
```sh
fluksio enroll <code>
```
and you're ready to rock.
Fluksio is distributed at it's heart.
A machine that should only *run nodes* for an engine elsewhere installs less:
```sh
@@ -71,18 +75,10 @@ make docs # static build into ./site
```
It is served at `docs.${DOMAIN}` by the `docs` service in `docker/compose.yml`,
and `.gitea/workflows/docs.yml` builds it with `--strict` on every push. Style
follows the root `DESIGN-GUIDELINES.md`; the tokens are mirrored in
`docs/stylesheets/extra.css`.
and `.gitea/workflows/docs.yml` builds it with `--strict` on every push.
Repo-only material:
- [`ROADMAP.md`](ROADMAP.md) — strategy and feature record
- [`NOTEPAD.md`](NOTEPAD.md) — deferred work and findings
- [`DESIGN.md`](DESIGN.md) — points at the workspace root's `DESIGN-GUIDELINES.md`
- `docs/architecture/` in the sibling `docs` repo — the requirement sources
## License
Copyright (C) 2026 Melvin Strobl GNU Affero General Public License v3.0 or
Copyright (C) 2026 Melvin Strobl - GNU Affero General Public License v3.0 or
later. See [LICENSE](LICENSE).