You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quick-start/README.md
+26-22Lines changed: 26 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@ meta:
17
17
18
18
# Quick Start Guide
19
19
20
-
This guide provides a streamlined process for setting up and running the FlowFuse platform using Docker and docker-compose.
20
+
This guide provides a streamlined process for setting up and running the FlowFuse platform using [Docker](https://docs.docker.com/get-started/) and [Docker Compose](https://docs.docker.com/compose/).
21
21
22
-
The provided docker-compose file facilitates the deployment of the following services:
22
+
The Docker Compose file deploys the following services:
23
23
***FlowFuse Platform**: Includes the core application, MQTT broker, and file server for storage
24
24
***Database:** A pre-configured database for storing platform data
25
25
***Proxy Server:** A pre-configured proxy server for managing HTTP traffic
@@ -28,51 +28,55 @@ For a full installation guide, including how to setup FlowFuse in a production e
28
28
29
29
## Prerequisites
30
30
31
-
Before you begin, ensure you have [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) (in `2.23.1` version or higher) installed on your system (either as a standalone binary or as docker plugin)
31
+
Before you begin, ensure you have [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) (in `2.23.1` version or higher) installed on your system (either as a standalone binary or as a Docker plugin).
32
32
33
-
## Step 1: Configure Domain
33
+
## Step 1: Prepare your domain
34
34
35
-
### No DNS Server
35
+
FlowFuse requires a domain name to work properly — it uses subdomains to run each Node-RED instance separately, so `localhost` won't work here.
36
36
37
-
If you're just looking to test FlowFuse locally, and do not have a local DNS server, then we recommend [setting up an alternative to DNS](../install/dns-setup.md#no-local-dns-server).
37
+
If you own a domain (e.g., `example.com` or `flowfuse.example.com`), create an **A record** pointing to your server's IP address, and another **A record** for the wildcard subdomain (e.g., `*.example.com` or `*.flowfuse.example.com`) pointing to the same address. That's all the setup needed.
38
38
39
-
### DNS Server
39
+
If you don't have a domain yet and just want to try FlowFuse locally, see [setting up an alternative to DNS](../install/dns-setup.md#no-local-dns-server).
40
40
41
-
Otherwise, before running FlowFuse, you need to configure your fully qualified domain name settings, and will need a domain name that you own and can configure DNS settings for:
41
+
## Step 2: Download files
42
42
43
-
1. Set up an A record for your domain (e.g., `example.com`) to your server's IP address (this works with subdomain as well e.g. `flowfuse.example.com`). FlowFuse will run here.
44
-
2. In the same manner, set up a wildcard DNS record (e.g., `*.example.com`, `*.flowfuse.example.com`) to point to your server's IP address. Any Node-RED instances setup by FlowFuse will run here.
sed -i.bak 's/^DOMAIN=.*/DOMAIN=example.com/' .env
52
56
```
53
57
54
-
## Step 3: Start the Application
58
+
## Step 4: Start the Application
55
59
56
-
Run the following command to deploy FlowFuse. Replace the `yourdomain.com` with your domain name configured in step 1.:
60
+
Run the following command to deploy FlowFuse:
57
61
58
62
```bash
59
-
DOMAIN=example.com docker compose up -d
63
+
docker compose up -d
60
64
```
61
65
62
-
This command will download the necessary Docker images, run initial setup and start all the required services in detached mode.
66
+
This downloads the necessary Docker images, runs initial setup, and starts all services in detached mode.
63
67
64
-
## Step 4: Complete the application Setup
68
+
## Step 5: Complete the application Setup
65
69
66
-
Open your web browser and navigate to `http://forge.example.com/setup`. You will be redirected to the setup page where you can create your admin account and set up your instance.
67
-
For detailed information about first setup and configuration, please follow [this guide](../install/first-run.md).
70
+
Open your web browser and navigate to `http://forge.<your-domain>/setup` (e.g., `http://forge.example.com/setup`). You will be redirected to the setup page where you can create your admin account and set up your instance.
71
+
For detailed information about first setup and configuration, follow [this guide](../install/first-run.md).
68
72
69
73
70
74
## Cleanup
71
75
72
-
To stop and remove the FlowFuse application, run the following command. Replace `yourdomain.com` with your domain name:
76
+
To stop and remove the FlowFuse application, run the following command:
0 commit comments