Make documentation standalone and generalize examples
This commit is contained in:
@@ -7,10 +7,11 @@ No hardware required for the first lap.
|
||||
|
||||
You need Git and Docker with Compose v2 on a 64-bit machine, x86 or ARM. A
|
||||
Raspberry Pi 4 or 5 with a 64-bit OS works too. Clone the app repository and
|
||||
start its single container:
|
||||
start its single container. Replace `<repository-url>` with the app
|
||||
repository's URL:
|
||||
|
||||
```sh
|
||||
git clone https://git.stroblme.de/Fluksio/app.git fluksio
|
||||
git clone <repository-url> fluksio
|
||||
cd fluksio
|
||||
docker compose up -d
|
||||
docker compose logs fluksio
|
||||
@@ -115,24 +116,25 @@ See [Dashboards and devices](../interface/dashboards.md) for widgets and pairing
|
||||
a wall tablet.
|
||||
|
||||
For longer-term history, add an **InfluxDB** node that consumes
|
||||
`living_temperature`. It needs the `influx` extra. Configure your server URL, organization, bucket, token
|
||||
and `writes` mapping. Store the token under **Secrets** and select it in the
|
||||
node's credential field. [Node types](../reference/node-types.md#influxdb)
|
||||
`living_temperature`. It needs the `influx` extra. Configure your database URL,
|
||||
organization, bucket, token and `writes` mapping. Store the token under
|
||||
**Secrets** and select it in the node's credential field.
|
||||
[Node types](../reference/node-types.md#influxdb)
|
||||
has the write and query formats.
|
||||
|
||||
Fluksio does not run an InfluxDB server either. Use your own.
|
||||
Run InfluxDB separately, just like the MQTT broker.
|
||||
|
||||
## Run it long term
|
||||
|
||||
The container from `compose.yml` is fit for long-term use. It restarts with
|
||||
Docker, and `/data` holds everything it keeps: the database, the flows,
|
||||
secrets, artifacts and its Redis. Back up that volume. Compose names it
|
||||
`fluksio_data`.
|
||||
secrets, artifacts and its Redis. Back up that volume. Compose prefixes its
|
||||
name with your project name.
|
||||
|
||||
The container speaks plain HTTP. For access from outside your network, put a
|
||||
reverse proxy with HTTPS and WebSocket support in front of it, such as Caddy,
|
||||
Traefik or nginx, or [enroll with the portal](../interface/portal.md). A
|
||||
Caddyfile for `fluksio.example.com` is one line:
|
||||
Traefik or nginx, or [enroll with the portal](../interface/portal.md).
|
||||
For example, a Caddyfile can proxy your app address:
|
||||
|
||||
```text
|
||||
fluksio.example.com {
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
# Pick your starting point
|
||||
|
||||
Choose the setup that fits your work.
|
||||
Both paths lead to the same Fluksio engine, with a first flow to try along the way.
|
||||
This is really just about a decision what you're planning to do with Fluksio.
|
||||
Pick the setup that fits your work. Both paths lead to the same engine, with
|
||||
a first flow to try along the way.
|
||||
|
||||
<div class="fluksio-lanes" markdown>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user