Skip to content

Commit 6bed107

Browse files
committed
Made ChirpStack setup non-optional
1 parent 060da57 commit 6bed107

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,25 @@ task open
5858
- Email: `global-admin@os2iot.dk`
5959
- Password: `hunter2`
6060

61+
#### ChirpStack Integration
62+
63+
> [!NOTE]
64+
> The backend must be able to talk to ChirpStack to create new applications etc.
65+
66+
```bash
67+
# Run the setup task - it will guide you through the process
68+
task setup:chirpstack
69+
```
70+
71+
Or manually:
72+
73+
1. Open ChirpStack UI: `task open:chirpstack`
74+
2. Login with `admin` / `admin`
75+
3. Go to **API Keys** → Create a new API key (`/#/api-keys/create`)
76+
4. Enter key name and press Submit.
77+
4. Add to `.env` file: `CHIRPSTACK_API_KEY=your-key-here`
78+
5. Restart the backend: `docker compose up --detach os2iot-backend`
79+
6180
**Available tasks:**
6281

6382
```bash
@@ -71,23 +90,6 @@ task clean # Remove containers, volumes, and images
7190
task open # Open frontend in browser
7291
```
7392

74-
### ChirpStack Integration (Optional)
75-
76-
If you're using LoRaWAN features, you need to configure the ChirpStack API key:
77-
78-
```bash
79-
# Run the setup task - it will guide you through the process
80-
task setup:chirpstack
81-
```
82-
83-
Or manually:
84-
1. Open ChirpStack UI: `task open:chirpstack`
85-
2. Login with `admin` / `admin`
86-
3. Go to **API Keys** → Create a new API key
87-
4. Add to `.env` file: `CHIRPSTACK_API_KEY=your-key-here`
88-
5. Restart backend: `docker compose up -d os2iot-backend`
89-
90-
Without this configuration, you'll see `InvalidToken` errors in the backend logs - these can be ignored if you're not using LoRaWAN features.
9193

9294
## Configuration
9395

0 commit comments

Comments
 (0)