Skip to content

Commit

Permalink
docs(GITBOOK#187): OpenWrt Installation Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
cpswan authored and gitbook-bot committed Feb 27, 2025
1 parent ca2e85b commit 4a75636
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
* [Installs at scale](installation/advanced-installation-guides/installs-at-scale.md)
* [Client installation](installation/advanced-installation-guides/client-installation-sshnp.md)
* [Client Upgrade](installation/advanced-installation-guides/client-upgrade-sshnp.md)
* [OpenWrt Installation Guide](installation/openwrt-installation-guide.md)
* [Custom OS/Device Installs](installation/custom-os-device-installs/README.md)
* [IPFire](installation/custom-os-device-installs/ipfire.md)
* [Cloud Installation Guides](installation/cloud-installation-guides/README.md)
Expand Down
30 changes: 30 additions & 0 deletions docs/installation/openwrt-installation-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
description: How to install NoPorts onto an OpenWrt router.
icon: router
---

# OpenWrt Installation Guide

### Using the LuCI web interface

First download the latest packages for your chosen architecture from our [releases](https://github.com/atsign-foundation/Atsign_OpenWRT_packages/releases) page.

We've created packages for x86\_64, aarch64\_cortex-a53, ramips and mips\_siflower; but if your chosen architecture isn't there please let us know by opening an [issue](https://github.com/atsign-foundation/Atsign_OpenWRT_packages/issues).

With the packages ready to go, sign into the web interface for your router and go to `System`> `Software` in the menu. Click on `Upload Package` and `Browse` to the csshnpd package you downloaded. Click `Open` then `Upload` and `Install`. Repeat that process with the luci-app-csshnpd package.

For the new menu to appear you'll need to `Log out` then sign in again.

You can now go to `Network`>`NoPorts` and fill out the config tab with your device atSign, manager atSign, device name and the OTP for key generation. Click the `Enabled` box then hit `Save & Apply`.

No go to the `NoPorts Enrollment` tab and follow the instructions there to generate a device key.

With the key in place navigate to `System`>`Startup` and `Start` the `sshnpd` service.

### Command line installation

The [releases](https://github.com/atsign-foundation/Atsign_OpenWRT_packages/releases) page includes instructions for command line installation, though these may need to be edited to suit your system architecture.

Those command line snippets set some variables for the `RELEASE` number and `PACKAGE` name then use `wget` to download the package from GitHub.

Packages are installed using `opkg install` for OpenWrt 24.10 and earlier releases that use `.ipk` type packages, or `apk add` for newer OpenWrt which uses `.apk` packages.

0 comments on commit 4a75636

Please sign in to comment.