Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Gunjan Gupta <[email protected]>
  • Loading branch information
viraniac committed Aug 29, 2024
1 parent 3e24eb8 commit 41b6de9
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 7 deletions.
45 changes: 40 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

# Armbian Configuration Utility
Updated: Wed 31 Jul 2024 23:44:46 NZST
Updated: Thu Aug 29 11:45:21 AM UTC 2024

Utility for configuring your board, adjusting services, and installing applications. It comes with Armbian by default.

Expand All @@ -12,7 +12,7 @@ sudo armbian-config
- ## **System**
- **S01** - Enable Armbian kernel upgrades
- **S02** - Disable Armbian kernel upgrades
- **S03** - Edit the boot environment (WIP)
- **S03** - Edit the boot environment
- **S04** - Install Linux headers
- **S05** - Remove Linux headers

Expand All @@ -28,6 +28,8 @@ sudo armbian-config
- **N07** - Disconnect and forget all wifi connections (Advanced)
- **N08** - Toggle system IPv6/IPv4 internet protocol
- **N09** - (WIP) Setup Hotspot/Access point
- **N10** - Announce system in the network (Avahi)
- **N11** - Disable system announce in the network (Avahi)


- ## **Localisation**
Expand Down Expand Up @@ -83,7 +85,7 @@ Usage: armbian-configng [option] [arguments]
--cli S01 - Enable Armbian kernel upgrades
--cli S02 - Disable Armbian kernel upgrades
--cli S03 - Edit the boot environment (WIP)
--cli S03 - Edit the boot environment
--cli S04 - Install Linux headers
--cli S05 - Remove Linux headers
--cli N00 - Install Bluetooth support
Expand All @@ -96,6 +98,8 @@ Usage: armbian-configng [option] [arguments]
--cli N07 - Disconnect and forget all wifi connections (Advanced)
--cli N08 - Toggle system IPv6/IPv4 internet protocol
--cli N09 - (WIP) Setup Hotspot/Access point
--cli N10 - Announce system in the network (Avahi)
--cli N11 - Disable system announce in the network (Avahi)
--cli L00 - Change Global timezone (WIP)
--cli L01 - Change Locales reconfigure the language and character set
--cli L02 - Change Keyboard layout
Expand Down Expand Up @@ -158,7 +162,7 @@ set_safe_boot freeze

### S03

Edit the boot environment (WIP)
Edit the boot environment

Jobs:

Expand Down Expand Up @@ -306,6 +310,36 @@ Do you wish to continue?" process_input
hotspot_setup
~~~

### N10

Announce system in the network (Avahi)

Jobs:

~~~
get_user_continue "This operation will install avahi-daemon and add configuration files.
Do you wish to continue?" process_input
check_if_installed avahi-daemon
debconf-apt-progress -- apt-get -y install avahi-daemon libnss-mdns
cp /usr/share/doc/avahi-daemon/examples/sftp-ssh.service /etc/avahi/services/
cp /usr/share/doc/avahi-daemon/examples/ssh.service /etc/avahi/services/
service avahi-daemon restart
~~~

### N11

Disable system announce in the network (Avahi)

Jobs:

~~~
get_user_continue "This operation will purge avahi-daemon
Do you wish to continue?" process_input
check_if_installed avahi-daemon
systemctl stop avahi-daemon avahi-daemon.socket
debconf-apt-progress -- apt-get -y purge avahi-daemon
~~~

### L00

Change Global timezone (WIP)
Expand Down Expand Up @@ -414,11 +448,11 @@ These helper functions facilitate various operations related to job management,
| Display a message box | show_message <<< 'hello world' | Joey Turner
| Migrated procedures from Armbian config. | connect_bt_interface | Igor Pecovnik
| Freeze/unhold Migrated procedures from Armbian config. | set_safe_boot unhold or set_safe_boot freeze | Igor Pecovnik
| Check if kernel headers are installed | are_headers_installed | Gunjan Gupta
| Check when apt list was last updated | see_current_apt | Joey Turner
| Migrated procedures from Armbian config. | check_if_installed nano | Igor Pecovnik
| Generate 'Armbian CPU logo' SVG for document file. | generate_svg | Joey Turner
| Remove Linux headers | Headers_remove | Joey Turner
| Show or hide menu items based on conditions | toggle_menu_item | Joey Turner
| Update submenu descriptions based on conditions | update_submenu_data | Joey Turner
| sanitize input cli | sanitize_input |
| Check if a domain is reachable via IPv4 and IPv6 | check_ip_version google.com | Joey Turner
Expand All @@ -435,6 +469,7 @@ These helper functions facilitate various operations related to job management,
| Serve the edit and debug server. | serve_doc | Joey Turner
| Update JSON data with system information | update_json_data | Joey Turner
| pipeline strings to an infobox | show_infobox <<< 'hello world' ; | Joey Turner
| Parse json to get list of desired menu or submenu items | parse_menu_items 'menu_options_array' | Gunjan Gupta
| Show the usage of the functions. | see_use | Joey Turner
| Check the internet connection with fallback DNS | see_ping | Joey Turner
| Secure version of get_user_continue | get_user_continue_secure 'Do you wish to continue?' process_input | Joey Turner
Expand Down
4 changes: 2 additions & 2 deletions lib/armbian-configng/config.ng.jobs.json
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@
},
{
"id": "N10",
"description": "Announce system in the network (Avahi) ",
"description": "Announce system in the network (Avahi)",
"command": [
"get_user_continue \"This operation will install avahi-daemon and add configuration files.\nDo you wish to continue?\" process_input",
"check_if_installed avahi-daemon",
Expand All @@ -217,7 +217,7 @@
},
{
"id": "N11",
"description": "Disable system announce in the network (Avahi) ",
"description": "Disable system announce in the network (Avahi)",
"command": [
"get_user_continue \"This operation will purge avahi-daemon \nDo you wish to continue?\" process_input",
"check_if_installed avahi-daemon",
Expand Down

0 comments on commit 41b6de9

Please sign in to comment.