Skip to content

Commit bf8109d

Browse files
committed
Revert "Shorter readme"
This reverts commit 3d9a182.
1 parent 7001048 commit bf8109d

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,51 @@ FlowFuse uses Docker Compose to install and manager the required components. Ins
1313
FlowFuse requires at least Docker Compose v2
1414

1515
These instructions assume you are running Docker on a Linux or MacOS host system.
16+
17+
### DNS
18+
19+
To access the Projects created you will need to set up a wildcard DNS entry that points to the `domain` entered in the `etc/flowforge.yml` file.
20+
21+
e.g. assuming that Docker is running on a machine with IP address `192.168.0.8` then an A record point to `*.example.com`.
22+
23+
This will mean that any host at `example.com` will resolve to the `192.168.0.8`.
24+
25+
**Note** When testing locally you can not use the loopback address `127.0.0.1` for this, e.g. in the `/etc/hosts` file, as this will resolve to the TCP/IP stack inside each container.
26+
27+
## Installing FlowFuse
28+
29+
### Building Containers
30+
31+
To build the required containers simply run `./build-containers.sh`.
32+
33+
This will build and tag `flowfuse/forge-docker` and `flowfuse/node-red` and `flowfuse/file-server`.
34+
35+
#### flowfuse/flowforge-docker
36+
37+
This container holds the FlowFuse App and the Docker Driver.
38+
39+
#### flowfuse/node-red
40+
41+
This is a basic Node-RED image with the FlowFuse Launcher and the required Node-RED plugins to talk to the FlowFuse Platform.
42+
43+
This is the container you can customize for your deployment.
44+
45+
#### flowfuse/file-server
46+
47+
This holds the Object Store used to allow persistent file storage for Projects running on Docker
48+
49+
## Configuration
50+
51+
Configuration details are stored in the `etc/flowforge.yml` file which is mapped into the `flowforge/forge-docker` container. You will need to edit this file to update the `domain` and `base_url` entries to match the DNS settings.
52+
53+
You also need to update the `VIRTUAL_HOST` entry in the `docker-compose.yml` file to use the same domain as in the `etc/flowforge.yml` file.
54+
55+
You should also update the `email` section to point to a local SMTP server so you can invite users to join teams.
56+
57+
### Creating Instance
58+
59+
Once the container have been built you can start the FlowFuse by running:
60+
61+
```
62+
docker-compose -p flowforge up -d
63+
```

0 commit comments

Comments
 (0)