Skip to content

Commit f515bfa

Browse files
authored
Document pre-install configuration for OpenWRT (#76)
1 parent 1c979e0 commit f515bfa

2 files changed

Lines changed: 44 additions & 3 deletions

File tree

docs/setup-sensor/gl-mt2500-standalone.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Before you begin, make sure you have:
3030

3131
The Brume 2 ships with the OpenWRT operating system, which is pre-configured with many features to act as a router, VPN gateway, and more. For this guide, we'll create a new OpenWRT image that installs the Orb sensor and configures the device to connect to your network as a monitoring device.
3232

33-
1. Visit the [OpenWRT Firmware Selector](https://firmware-selector.openwrt.org/?version=24.10.0&target=mediatek%2Ffilogic&id=glinet_gl-mt2500) for the Brume 2 GL-MT2500
33+
1. Visit the [OpenWRT Firmware Selector](https://firmware-selector.openwrt.org/?version=24.10.6&target=mediatek%2Ffilogic&id=glinet_gl-mt2500) for the Brume 2 GL-MT2500
3434
2. Click "Customize installed packages and/or first boot script" to expand the customization options
3535

3636
![Customize installed packages and/or first boot script](../../images/gl-mt2500/1.2.png)
@@ -85,6 +85,18 @@ ln -s /overlay/orb /.config/orb
8585

8686
echo "src/gz orb_packages $URL" | tee -a /etc/opkg/customfeeds.conf
8787

88+
# Optional: Customize Orb configuration before first launch
89+
# You can set a deployment token to automatically link this Orb to your Orb Space, or adjust other settings.
90+
# See the https://orb.net/docs/deploy-and-configure/configuration for all available options.
91+
#
92+
# cat << EOF > /etc/config/orb
93+
# config orb 'orb'
94+
# list env 'ORB_DATA_DIR=/root'
95+
# list env 'ORB_EPHEMERAL_MODE=1'
96+
# list env 'ORB_LOG_CONSOLE_FORMAT=syslog'
97+
# list env 'ORB_DEPLOYMENT_TOKEN=<YOUR-DEPLOYMENT-TOKEN-HERE>'
98+
# EOF
99+
88100
# Create orb-setup service
89101
cat << EOF > /etc/init.d/orb-setup
90102
#!/bin/sh /etc/rc.common

docs/setup-sensor/linux/openwrt.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,22 @@ Before you begin, make sure you have:
4141
3. If prompted about the authenticity of the host, type `yes` and press Enter.
4242
4. Enter the root password for your OpenWrt device when prompted. You should now have a command prompt logged into your OpenWrt device.
4343

44-
## Step 2: Install Orb
44+
## Step 2: Pre-configure Orb (Optional)
45+
You can optionally create a configuration file to customize Orb behavior from the start. You can set a deployment token to automatically link this Orb to your Orb Space, or adjust other settings. See the [configuration docs](/docs/deploy-and-configure/configuration) for all available options.
46+
47+
1. Create the configuration file:
48+
49+
```bash
50+
cat << EOF > /etc/config/orb
51+
config orb 'orb'
52+
list env 'ORB_DATA_DIR=/root'
53+
list env 'ORB_EPHEMERAL_MODE=1'
54+
list env 'ORB_LOG_CONSOLE_FORMAT=syslog'
55+
list env 'ORB_DEPLOYMENT_TOKEN=<YOUR-DEPLOYMENT-TOKEN-HERE>'
56+
EOF
57+
```
58+
59+
## Step 3: Install Orb
4560
4661
1. At the OpenWrt command prompt, run the following command exactly as shown:
4762
@@ -57,7 +72,9 @@ Before you begin, make sure you have:
5772
- Enable auto-updates to keep Orb up-to-date.
5873
3. Wait for the script to complete. You should see output indicating the progress of the installation.
5974
60-
## Step 3: Link your new Orb Sensor
75+
## Step 4: Link your new Orb Sensor (Optional)
76+
77+
If you didn't configure a Deployment Token to auto-link your new Orb in Step 2, you can link it to your Orb Space now.
6178
6279
1. Once the installation script finishes, the Orb Sensor should be running on your OpenWrt device.
6380
2. Open the Orb app on your phone or personal computer.
@@ -95,6 +112,18 @@ Add the Orb public key
95112
curl https://pkgs.orb.net/stable/openwrt/key.pub | tee /etc/opkg/keys/744a82bfef3c5690
96113
```
97114
115+
Optionally, you can create a configuration file to customize Orb behavior from the start. You can set a deployment token to automatically link this Orb to your Orb Space, or adjust other settings. See the [configuration docs](/docs/deploy-and-configure/configuration) for all available options.
116+
117+
```bash
118+
cat << EOF > /etc/config/orb
119+
config orb 'orb'
120+
list env 'ORB_DATA_DIR=/root'
121+
list env 'ORB_EPHEMERAL_MODE=1'
122+
list env 'ORB_LOG_CONSOLE_FORMAT=syslog'
123+
list env 'ORB_DEPLOYMENT_TOKEN=<YOUR-DEPLOYMENT-TOKEN-HERE>'
124+
EOF
125+
```
126+
98127
Install Orb
99128
100129
```bash

0 commit comments

Comments
 (0)