Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(automated): Update docs from Gitbook #1755

Merged
merged 4 commits into from
Feb 27, 2025
Merged

docs(automated): Update docs from Gitbook #1755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a62208
docs(GITBOOK#185): No subject
cconstab Feb 22, 2025
ca2e85b
docs(GITBOOK#186): No subject
cconstab Feb 22, 2025
4a75636
docs(GITBOOK#187): OpenWrt Installation Guide
cpswan Feb 27, 2025
9d69a66
Merge branch 'trunk' into gitbook
cpswan Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/.gitbook/includes/windows-download-installer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ title: windows-download-installer

## Step 1: Download the installer

Download the installer [from GitHub](https://github.com/atsign-foundation/noports/releases/download/v5.8.2/NoPortsInstaller-windows-x64.zip). Then unzip the file.
Download the installer [from GitHub](https://github.com/atsign-foundation/noports/releases/download/v5.8.7/NoPortsInstaller-windows-x64.zip). Then unzip the file.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
View file
Open in desktop
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
View file
Open in desktop
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.
Loading