Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions services/fossflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,37 @@ This stack runs FossFLOW with a Tailscale sidecar, as described in [the standard

## At a glance

| Item | Value |
| ------------- | ----------------------------------- |
| Web interface | `https://fossflow.<tailnet>.ts.net` |
| Service port | `80` |
| Image | `stnsmith/fossflow` |
| Data | None on the host |
| Item | Value |
| ------------- | --------------------------------------------------------- |
| Web interface | `https://fossflow.<tailnet>.ts.net` |
| Service port | `80` |
| Image | `stnsmith/fossflow` |
| Data | `./fossflow-data/diagrams` (diagrams saved on the server) |

## Before you start

Set `PUBLIC_URL` in `compose.yaml` to the address of the web interface, `https://fossflow.<tailnet>.ts.net`.

## Deviations from the standard setup

- **Diagrams are not stored on the host.** FossFLOW saves diagrams on the server in `/data/diagrams` in the container, which this stack does not mount. They are lost when the container is recreated, for example after an image update. Export the diagrams that you want to keep.
None.

## First run

Nothing to set up. Open the web interface.

## Upgrading

Earlier versions of this stack had no volume for the diagrams. FossFLOW kept them inside the container, and they were lost when the container was recreated. The stack now stores them in `./fossflow-data/diagrams`.

If you run an earlier version and saved diagrams on the server, copy them to the host before you start the new version:

```bash
mkdir -p fossflow-data/diagrams
docker cp app-fossflow:/data/diagrams/. ./fossflow-data/diagrams/
docker compose up -d
```

## Links

- [FossFLOW image on Docker Hub](https://hub.docker.com/r/stnsmith/fossflow)
Expand Down
2 changes: 2 additions & 0 deletions services/fossflow/compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ services:
environment:
- PUBLIC_URL=https://fossflow.<YOUR-TS-DOMAIN>.ts.net
- TZ=${TZ}
volumes:
- ./${SERVICE}-data/diagrams:/data/diagrams # Diagrams saved on the server
depends_on:
tailscale:
condition: service_healthy
Expand Down
Loading