Skip to content

Commit

Permalink
Merge branch 'main' into atuin
Browse files Browse the repository at this point in the history
  • Loading branch information
Tearran authored Dec 2, 2024
2 parents 171df5b + 6fc59d1 commit 246cb4f
Show file tree
Hide file tree
Showing 66 changed files with 1,745 additions and 151 deletions.
85 changes: 78 additions & 7 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,31 @@ sudo armbian-config
- ### Remove hostname broadcast via mDNS (avahi-daemon)


- ### Download tools
- ### Install qBittorrent
- ### Remove qBittorrent
- ### Install Deluge
- ### Remove Deluge
- ### Install Transmission
- ### Remove Transmission
- ### Install SABnzbd
- ### Remove SABnzbd
- ### Install Medusa
- ### Remove Medusa
- ### Install Sonarr
- ### Remove Sonarr
- ### Install Radarr
- ### Remove Radarr
- ### Install Bazarr
- ### Remove Bazarr
- ### Install Lidarr
- ### Remove Lidarr
- ### Install Readarr
- ### Remove Readarr
- ### Install Prowlarr
- ### Remove Prowlarr


- ### DNS blockers
- ### Install Pi-hole DNS ad blocker
- ### Set Pi-hole web admin password
Expand All @@ -128,6 +153,8 @@ sudo armbian-config
- ### Home Automation
- ### Install openHAB
- ### Remove openHAB
- ### Install Home Assistant
- ### Remove Home Assistant


- ### System benchmaking and diagnostics
Expand Down Expand Up @@ -252,6 +279,29 @@ Outputs:
--cmd NET006 - Remove IP LAN monitor (iptraf-ng)
--cmd NET007 - Install hostname broadcast via mDNS (avahi-daemon)
--cmd NET008 - Remove hostname broadcast via mDNS (avahi-daemon)
Downloaders - Download tools
--cmd DOW001 - Install qBittorrent
--cmd DOW002 - Remove qBittorrent (http://10.1.0.7:8090 6881)
--cmd DOW003 - Install Deluge
--cmd DOW004 - Remove Deluge (http://10.1.0.7:8112 6181 58846)
--cmd DOW005 - Install Transmission
--cmd DOW006 - Remove Transmission (http://10.1.0.7:9091)
--cmd DOW011 - Install SABnzbd
--cmd DOW012 - Remove SABnzbd (http://10.1.0.7:8080)
--cmd DOW013 - Install Medusa
--cmd DOW014 - Remove Medusa (http://10.1.0.7:8081)
--cmd DOW015 - Install Sonarr
--cmd DOW016 - Remove Sonarr (http://10.1.0.7:8989)
--cmd DOW017 - Install Radarr
--cmd DOW018 - Remove Radarr (http://10.1.0.7:7878)
--cmd DOW019 - Install Bazarr
--cmd DOW020 - Remove Bazarr (http://10.1.0.7:6767)
--cmd DOW021 - Install Lidarr
--cmd DOW022 - Remove Lidarr (http://10.1.0.7:8686)
--cmd DOW023 - Install Readarr
--cmd DOW024 - Remove Readarr (http://10.1.0.7:8787)
--cmd DOW025 - Install Prowlarr
--cmd DOW026 - Remove Prowlarr (http://10.1.0.7:9696)
DNS - DNS blockers
--cmd DNS001 - Install Pi-hole DNS ad blocker
--cmd DNS002 - Set Pi-hole web admin password
Expand All @@ -262,14 +312,16 @@ Outputs:
HomeAutomation - Home Automation
--cmd HA001 - Install openHAB
--cmd HA002 - Remove openHAB
--cmd HA003 - Install Home Assistant
--cmd HA004 - Remove Home Assistant (http://10.1.0.7:8123)
--cmd Benchy - System benchmaking and diagnostics
Containers - Containerlization and Virtual Machines
--cmd CON001 - Install Docker Minimal
--cmd CON002 - Install Docker Engine
--cmd CON003 - Remove Docker
--cmd CON004 - Purge all Docker images, containers, and volumes
--cmd CON005 - Install Portainer
--cmd CON006 - Remove Portainer
--cmd CON006 - Remove Portainer (http://10.1.0.7:9000)
Media - Media Servers and Editors
--cmd MED001 - Install Plex Media server
--cmd MED002 - Remove Plex Media server
Expand Down Expand Up @@ -358,7 +410,7 @@ Install Linux headers
Jobs:
~~~
Headers_install
module_headers install
~~~
### SY005
Expand All @@ -368,7 +420,7 @@ Remove Linux headers
Jobs:
~~~
Headers_remove
module_headers remove
~~~
### SY006
Expand Down Expand Up @@ -544,6 +596,16 @@ Jobs:
No commands available
~~~
### Downloaders
Download tools
Jobs:
~~~
No commands available
~~~
### DNS
DNS blockers
Expand Down Expand Up @@ -652,11 +714,15 @@ These helper functions facilitate various operations related to job management,
| Generate this markdown table of all module_options | see_function_table_md | @Tearran
| Switching to alternative kernels | switch_kernels | @igorpecovnik
| Webmin setup and service setting. | help install remove start stop enable disable status check | @Tearran
| Hos container install and configure | help install uninstall | @igorpecovnik
| Set Armbian root filesystem to read only | manage_overlayfs enable/disable | @igorpecovnik
| Display a menu from pipe | show_menu <<< armbianmonitor -h ; | @Tearran
| Build the main menu from a object | generate_top_menu 'json_data' | @Tearran
| Install bazarr container | install remove status help | @igorpecovnik
| Install headers container | install remove status help | @armbian
| Migrated procedures from Armbian config. | is_package_manager_running | @armbian
| Migrated procedures from Armbian config. | check_desktop | @armbian
| Install sonarr container | install remove status help | @armbian
| Generate Document files. | generate_readme | @Tearran
| Storing netplan config to tmp | store_netplan_config | @igorpecovnik
| Needed by generate_menu | execute_command 'id' | @Tearran
Expand All @@ -667,42 +733,47 @@ These helper functions facilitate various operations related to job management,
| Enable/disable device tree overlays | manage_dtoverlays | @viraniac
| Show or generate QR code for Google OTP | qr_code generate | @igorpecovnik
| Install/uninstall/check status of pi-hole container | help install uninstall status password | @armbian
| Check if kernel headers are installed | are_headers_installed | @viraniac
| Check when apt list was last updated and suggest updating or update | see_current_apt or see_current_apt update | @Tearran
| Install/uninstall/check status of portainer container | help install uninstall status | @armbian
| Migrated procedures from Armbian config. | check_if_installed nano | @armbian
| Generate 'Armbian CPU logo' SVG for document file. | generate_svg | @Tearran
| Remove Linux headers | Headers_remove | @Tearran
| Update submenu descriptions based on conditions | update_submenu_data | @Tearran
| sanitize input cli | sanitize_input | @Tearran
| Install lidarr container | install remove status help | @armbian
| Check if a domain is reachable via IPv4 and IPv6 | check_ip_version google.com | @Tearran
| Install embyserver from repo using apt | install_embyserver | @schwar3kat
| Migrated procedures from Armbian config. | set_header_remove | @igorpecovnik
| Install deluge container | install remove status help | @armbian
| Generate a submenu from a parent_id | generate_menu 'parent_id' | @Tearran
| Install docker from a repo using apt | install_docker engine | @schwar3kat
| Generate a markdown list json objects using jq. | see_jq_menu_list | @Tearran
| Generate jobs from JSON file. | generate_jobs_from_json | @Tearran
| Install kernel headers | is_package_manager_running | @Tearran
| Install radarr container | install remove status help | @armbian
| Toggle IPv6 on or off | toggle_ipv6 | @Tearran
| Adjust welcome screen (motd) | adjust_motd clear, header, sysinfo, tips, commands | @igorpecovnik
| Install qbittorrent container | install remove status help | @armbian
| Generate JSON-like object file. | generate_json | @Tearran
| Install transmission container | install remove status help | @armbian
| Install wrapper | apt_install_wrapper apt-get -y purge armbian-zsh | @igorpecovnik
| Uses Avalible (Whiptail, DIALOG, READ) for the menu interface | <function_name> | Tearran
| Netplan wrapper | network_config | @igorpecovnik
| Install medusa container | install remove status help | @armbian
| Change the background color of the terminal or dialog box | set_colors 0-7 | @Tearran
| Show general information about this tool | about_armbian_configng | @igorpecovnik
| Serve the edit and debug server. | serve_doc | @Tearran
| Update JSON data with system information | update_json_data | @Tearran
| pipeline strings to an infobox | show_infobox <<< 'hello world' ; | @Tearran
| Install readarr container | install remove status help | @armbian
| Install/uninstall/check status of uptime kuma container | install uninstall status | @armbian
| Stop hostapd, clean config | default_wireless_network_config | @igorpecovnik
| Update sub-submenu descriptions based on conditions | update_sub_submenu_data "MenuID" "SubID" "SubSubID" "CMD" | @Tearran
| Parse json to get list of desired menu or submenu items | parse_menu_items 'menu_options_array' | @viraniac
| Show the usage of the functions. | see_use | @Tearran
| Install Desktop environment | manage_desktops xfce install | @igorpecovnik
| Set system shell to BASH | manage_zsh enable|disable | @igorpecovnik
| Install sabnzbd container | install remove status help | @armbian
| Generate a Help message for cli commands. | see_cmd_list [category] | @Tearran
| Revert network config back to Armbian defaults | default_network_config | @igorpecovnik
| Install prowlarr container | install remove status help | @armbian
| freeze, unhold, reinstall armbian related packages. | armbian_fw_manipulate unhold/freeze/reinstall | @igorpecovnik
| Check the internet connection with fallback DNS | see_ping | @Tearran
| Upgrade to next stable or rolling release | release_upgrade stable verify | @igorpecovnik
Expand Down
Binary file added tools/include/images/DOW001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW005.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW011.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW013.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW015.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW017.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW019.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW021.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW023.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/DOW025.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tools/include/images/HA003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions tools/include/markdown/DOW001-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
=== "Access to the web interface"

The web interface is accessible via port **8090**:

- URL: `https://<your.IP>:8090`
- Username/Password: admin / generate at first web interface login

=== "Directories"

- Install directory: `/armbian/qbittorrent`
- Site configuration directory: `/armbian/qbittorrent/config`
- Download directory: `/armbian/qbittorrent/downloads`

=== "View logs"

```sh
docker logs -f qbittorrent
```
1 change: 1 addition & 0 deletions tools/include/markdown/DOW001-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The Qbittorrent⁠ project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library.
18 changes: 18 additions & 0 deletions tools/include/markdown/DOW003-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
=== "Access to the web interface"

The web interface is accessible via port **8112**:

- URL: `https://<your.IP>:8112`
- Username/Password: default user/password of admin/deluge

=== "Directories"

- Install directory: `/armbian/deluge`
- Site configuration directory: `/armbian/deluge/config`
- Download directory: `/armbian/deluge/downloads`

=== "View logs"

```sh
docker logs -f deluge
```
1 change: 1 addition & 0 deletions tools/include/markdown/DOW003-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Deluge⁠ is a lightweight, Free Software, cross-platform BitTorrent client.
19 changes: 19 additions & 0 deletions tools/include/markdown/DOW005-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
=== "Access to the web interface"

The web interface is accessible via port **9091**:

- URL: `https://<your.IP>:9091`
- Username/Password: admin / generate at first web interface login

=== "Directories"

- Install directory: `/armbian/transmission`
- Site configuration directory: `/armbian/transmission/config`
- Download directory: `/armbian/transmission/downloads`
- Watch directory: `/armbian/transmission/watch`

=== "View logs"

```sh
docker logs -f transmission
```
1 change: 1 addition & 0 deletions tools/include/markdown/DOW005-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Transmission⁠ is designed for easy, powerful use. Transmission has the features you want from a BitTorrent client: encryption, a web interface, peer exchange, magnet links, DHT, µTP, UPnP and NAT-PMP port forwarding, webseed support, watch directories, tracker editing, global and per-torrent speed limits, and more.
19 changes: 19 additions & 0 deletions tools/include/markdown/DOW011-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
=== "Access to the web interface"

The web interface is accessible via port **8080**:

- URL: `https://<your.IP>:8080`
- Username/Password: admin / generate at first web interface login

=== "Directories"

- Install directory: `/armbian/sabnzbd`
- Site configuration directory: `/armbian/sabnzbd/config`
- Download directory: `/armbian/sabnzbd/downloads`
- Incomplete downloads: `/armbian/sabnzbd/incomplete`

=== "View logs"

```sh
docker logs -f sabnzbd
```
1 change: 1 addition & 0 deletions tools/include/markdown/DOW011-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Sabnzbd⁠ makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction.
18 changes: 18 additions & 0 deletions tools/include/markdown/DOW013-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
=== "Access to the web interface"

The web interface is accessible via port **8081**:

- URL: `https://<your.IP>:8081`

=== "Directories"

- Install directory: `/armbian/medusa`
- Site configuration directory: `/armbian/medusa/config`
- Download directory: `/armbian/medusa/downloads`
- Download directory TV shows: `/armbian/medusa/downloads/tv`

=== "View logs"

```sh
docker logs -f medusa
```
1 change: 1 addition & 0 deletions tools/include/markdown/DOW013-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Medusa is an automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
18 changes: 18 additions & 0 deletions tools/include/markdown/DOW015-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
=== "Access to the web interface"

The web interface is accessible via port **8989**:

- URL: `https://<your.IP>:8989`

=== "Directories"

- Install directory: `/armbian/sonarr`
- Site configuration directory: `/armbian/sonarr/config`
- Download directory: `/armbian/sonarr/tvseries`
- Client download directory: `/armbian/sonarr/client`

=== "View logs"

```sh
docker logs -f sonarr
```
1 change: 1 addition & 0 deletions tools/include/markdown/DOW015-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Sonarr (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
19 changes: 19 additions & 0 deletions tools/include/markdown/DOW017-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
=== "Access to the web interface"

The web interface is accessible via port **7878**:

- URL: `https://<your.IP>:7878`
- Username/Password: admin / generate at first web interface login

=== "Directories"

- Install directory: `/armbian/radarr`
- Site configuration directory: `/armbian/radarr/config`
- Download directory: `/armbian/radarr/movies`
- Client download directory: `/armbian/radarr/client`

=== "View logs"

```sh
docker logs -f radarr
```
1 change: 1 addition & 0 deletions tools/include/markdown/DOW017-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Radarr - A fork of Sonarr to work with movies à la Couchpotato.
18 changes: 18 additions & 0 deletions tools/include/markdown/DOW019-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
=== "Access to the web interface"

The web interface is accessible via port **6767**:

- URL: `https://<your.IP>:6767`
- Username/Password: admin / generate at first web interface login

=== "Directories"

- Install directory: `/armbian/bazarr`
- Site configuration directory: `/armbian/bazarr/config`
- Download directory: `/armbian/bazarr/movies` `/armbian/bazarr/tv`

=== "View logs"

```sh
docker logs -f bazarr
```
1 change: 1 addition & 0 deletions tools/include/markdown/DOW019-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Bazarr is a companion application to Sonarr and Radarr. It can manage and download subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you.
18 changes: 18 additions & 0 deletions tools/include/markdown/DOW021-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
=== "Access to the web interface"

The web interface is accessible via port **8686**:

- URL: `https://<your.IP>:8686`
- Username/Password: admin / generate at first web interface login

=== "Directories"

- Install directory: `/armbian/lidarr`
- Site configuration directory: `/armbian/lidarr/config`
- Download directory: `/armbian/lidarr/downloads` `/armbian/lidarr/music`

=== "View logs"

```sh
docker logs -f lidarr
```
1 change: 1 addition & 0 deletions tools/include/markdown/DOW021-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
Loading

0 comments on commit 246cb4f

Please sign in to comment.