OpenWrt
Version 1.0.0-beta 1
Step 1. Download the latest release
- Download the file to your device: comming soon
Step 2. Generate a Provision Key on the OrpheLink
- Log in to the OrpheLink and navigate to the Provision page.
- Generate and copy a new Provision Key for your device.
Step 3. Install OrpheAgent and LuCI Web UI on the Device
- Upload the OrpheAgent .ipk package to your OpenWrt/LEDE device. The package will be named.
orphe_agent_1.0.0-beta.1_ARCHITECTURE.ipk (replace ARCHITECTURE with your device architecture, e.g., amd64, armhf, arm64). - (Optional, recommended) Upload the LuCI Web UI package luci-app-orphe-agent_1.0.0-beta.1.ipk to your device for web-based management.
- Install the packages using the following commands:
The LuCI package is optional but provides a graphical interface for configuration and monitoring via the router's web UI.opkg install orphe_agent_1.0.0-beta.1_ARCHITECTURE.ipk opkg install luci-app-orphe-agent_1.0.0-beta.1.ipk
Example
To install the package for the armhf architecture:
opkg install orphe_agent_1.0.0-beta.1_armhf.ipk
Step 4. Register the Provision Key
- Run the following command and paste your Provision Key:
orphe-agent config save --provision-key [YOUR PROVISION_KEY] - You will see output similar to:
Saved configuration at /etc/orphe-agent/orphe-agent.yaml To edit the config run: sudo nano /etc/orphe-agent/orphe-agent.yaml Restart the OrpheAgent to apply the new configuration. To restart the OrpheAgent run: sudo orphe-agent down sudo orphe-agent up Do you want to restart the OrpheAgent now? (yes/no): yes Restarting OrpheAgent... - When prompted "Do you want to restart the OrpheAgent now? (yes/no):", type yes to let OrpheAgent automatically restart and apply the new configuration
Step 5. Discover and Provision the New Agent on the OrpheLink
- Go back to the OrpheLink Provision page and click re-discover. The new agent will appear in the device list.
- Select the OrpheAgent device, then click the provision button at the bottom to let the OrpheLink take over management.
- After provisioning succeeds, you can see the device on the OrpheLink's inventory page.
Dependencies
orphe_agent_1.0.0-beta.1_.ipk
The OrpheAgent binary package requires the following dependencies to function correctly (these will be handled by opkg if available):
- ip-full
- ipset
- shadow-groupadd
- kmod-tun
- conntrack
- iptables-nft
- kmod-ipt-conntrack
- kmod-ipt-nat
luci-app-orphe-agent_1.0.0-beta.1.ipk
- luci
- rpcd
- uhttpd
- orphe-agent (the OrpheAgent binary package)
- lua
- liblua
- luci-base
- luci-lib-base
- luci-lib-nixio
- curl
All dependencies will be automatically managed by opkg during installation if available in your package sources.
Service Management
After installation, OrpheAgent will be set up as an init.d service. You can manage the service using standard OpenWrt/LEDE commands:
- Start the service:
/etc/init.d/orphe-agent start - Stop the service:
/etc/init.d/orphe-agent stop - Restart the service:
/etc/init.d/orphe-agent restart - Enable the service at boot:
/etc/init.d/orphe-agent enable - Disable the service at boot:
/etc/init.d/orphe-agent disable
