Skip to content

Add console setup helper #1712

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

Merged
gsanchietti merged 5 commits into from
Jun 18, 2026
Merged

Add console setup helper #1712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f29ef2
feat(ns-api): add console setup helper
filippocarletti Jun 5, 2026
0185ec2
fix(ns-api): handle complex setup networks
filippocarletti Jun 8, 2026
b035db2
feat(setup): improve UX
gsanchietti Jun 18, 2026
ff6cc1d
fix(setup): apply suggestions from code review
gsanchietti Jun 18, 2026
f5a0d96
fix(setup): apply suggestions from code review
gsanchietti Jun 18, 2026
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
12 changes: 12 additions & 0 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,18 @@ See the [install page]({{site.manual_url}}/install.html) inside manual.

See the [access page]({{site.manual_url}}/remote_access.html) inside manual.

## Console setup

The image ships the `/usr/sbin/setup` helper for basic console-first
configuration.

The command uses a `whiptail` interface to:

- switch the console keyboard between `it` and the default `us`
- assign physical network cards to `lan` and `wan`
- configure `lan` IPv4/CIDR
- configure `wan` as `dhcp` or `static`

### LuCI

The following sections/options should not be changed from the web interface:
Expand Down
2 changes: 2 additions & 0 deletions packages/ns-api/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ define Package/ns-api
+python3-requests \
+python3-semver \
+python3-urllib \
+whiptail \
+sshpass \
+wireguard-tools
EXTRA_DEPENDS:=adblock (>=4.5.3)
Expand Down Expand Up @@ -183,6 +184,7 @@ define Package/ns-api/install
$(INSTALL_CONF) files/nat-helpers.keep $(1)/lib/upgrade/keep.d/nat-helpers
$(LN) /usr/bin/msmtp $(1)/usr/sbin/sendmail
$(INSTALL_BIN) ./files/load-kernel-modules $(1)/usr/sbin/load-kernel-modules
$(INSTALL_BIN) ./files/setup $(1)/usr/sbin/setup
$(INSTALL_BIN) ./files/firewall-apply-default-logging $(1)/usr/sbin/firewall-apply-default-logging
$(INSTALL_DIR) $(1)/etc/config
$(INSTALL_CONF) ./files/config/ns-api $(1)/etc/config/ns-api
Expand Down
Loading
Loading