diff --git a/docs/User-Guide_Armbian-Config/System.md b/docs/User-Guide_Armbian-Config/System.md index af9291f4..22b85ca0 100644 --- a/docs/User-Guide_Armbian-Config/System.md +++ b/docs/User-Guide_Armbian-Config/System.md @@ -583,5 +583,33 @@ armbian-config --cmd SY207 +*** + +### Enable automating Docker container base images updating +**Command:** +~~~ +armbian-config --cmd WTC001 +~~~ + +**Author:** @armbian + +**Status:** Stable + + + +*** + +### Disable automating Docker container base images updating +**Command:** +~~~ +armbian-config --cmd WTC002 +~~~ + +**Author:** @armbian + +**Status:** Stable + + + *** diff --git a/docs/User-Guide_Armbian-Software/Containers.md b/docs/User-Guide_Armbian-Software/Containers.md index bb7c6057..7713ed1d 100644 --- a/docs/User-Guide_Armbian-Software/Containers.md +++ b/docs/User-Guide_Armbian-Software/Containers.md @@ -1,12 +1,12 @@ -# Containerlization and Virtual Machines +# Docker containerization and KVM virtual machines *** -## Install Docker Minimal +## Docker Minimal Install -[![Install Docker Minimal](/images/CON001.webp)](#) +[![Docker Minimal Install](/images/CON001.webp)](#) This operation will install Docker Minimal. @@ -30,7 +30,7 @@ What is Docker? Docker helps developers build, share, run, and verify applicatio *** -## Install Docker Engine +## Docker Engine Install This operation will install Docker Engine. **Command:** @@ -46,7 +46,7 @@ armbian-config --cmd CON002 *** -## Remove Docker +## Docker Remove This operation will purge Docker. **Command:** @@ -62,7 +62,7 @@ armbian-config --cmd CON003 *** -## Purge all Docker images, containers, and volumes +## Docker Purge all images, containers, and volumes This operation will delete all Docker images, containers, and volumes. **Command:** @@ -78,10 +78,10 @@ armbian-config --cmd CON004 *** -## Install Portainer +## Portainer container management platform -[![Install Portainer](/images/CON005.webp)](#) +[![Portainer container management platform](/images/CON005.webp)](#) @@ -113,7 +113,7 @@ armbian-config --cmd CON005 *** -## Remove Portainer +## Portainer remove **Command:** ~~~ armbian-config --cmd CON006 @@ -127,10 +127,10 @@ armbian-config --cmd CON006 *** -## Watchtower install +## Portainer purge with with data folder -[![Watchtower install](/images/CON007.png)](#) +[![Portainer purge with with data folder](/images/CON007.png)](#) @@ -156,19 +156,5 @@ Every day watchtower will pull the latest images and compare it to the one that -*** - -## Watchtower remove -**Command:** -~~~ -armbian-config --cmd CON008 -~~~ - -**Author:** @armbian - -**Status:** Stable - - - *** diff --git a/docs/User-Guide_Armbian-Software/DNS.md b/docs/User-Guide_Armbian-Software/DNS.md index f84790e9..82548c5c 100644 --- a/docs/User-Guide_Armbian-Software/DNS.md +++ b/docs/User-Guide_Armbian-Software/DNS.md @@ -1,12 +1,12 @@ -# DNS blockers +# Network-wide ad blockers servers *** -## Install Pi-hole DNS ad blocker +## Pi-hole DNS ad blocker install -[![Install Pi-hole DNS ad blocker](/images/DNS001.png)](#) +[![Pi-hole DNS ad blocker install](/images/DNS001.png)](#) @@ -44,21 +44,7 @@ armbian-config --cmd DNS001 *** -## Set Pi-hole web admin password -**Command:** -~~~ -armbian-config --cmd DNS002 -~~~ - -**Author:** @armbian - -**Status:** Stable - - - -*** - -## Remove Pi-hole DNS ad blocker +## Pi-hole remove **Command:** ~~~ armbian-config --cmd DNS003 @@ -70,5 +56,33 @@ armbian-config --cmd DNS003 +*** + +## Pi-hole change web admin password +**Command:** +~~~ +armbian-config --cmd DNS002 +~~~ + +**Author:** @armbian + +**Status:** Stable + + + +*** + +## Pi-hole purge +**Command:** +~~~ +armbian-config --cmd DNS004 +~~~ + +**Author:** @armbian + +**Status:** Stable + + + *** diff --git a/docs/User-Guide_Armbian-Software/Database.md b/docs/User-Guide_Armbian-Software/Database.md index abdfc5de..581d44ee 100644 --- a/docs/User-Guide_Armbian-Software/Database.md +++ b/docs/User-Guide_Armbian-Software/Database.md @@ -1,4 +1,4 @@ -# Database +# SQL database servers and web interface managers *** diff --git a/docs/User-Guide_Armbian-Software/DevTools.md b/docs/User-Guide_Armbian-Software/DevTools.md index 1d28ae9b..bd7d4729 100644 --- a/docs/User-Guide_Armbian-Software/DevTools.md +++ b/docs/User-Guide_Armbian-Software/DevTools.md @@ -1,4 +1,4 @@ -# Development +# Applications and tools for development *** diff --git a/docs/User-Guide_Armbian-Software/Downloaders.md b/docs/User-Guide_Armbian-Software/Downloaders.md index 219f8309..d50e9c06 100644 --- a/docs/User-Guide_Armbian-Software/Downloaders.md +++ b/docs/User-Guide_Armbian-Software/Downloaders.md @@ -1,12 +1,12 @@ -# Download tools +# P2P download managers for movies, TV shows, music and subtitles *** -## Install qBittorrent +## qBittorrent BitTorrent server -[![Install qBittorrent](/images/DOW001.png)](#) +[![qBittorrent BitTorrent server ](/images/DOW001.png)](#) @@ -15,6 +15,8 @@ The Qbittorrent⁠ project aims to provide an open-source software alternative t +This operation will install qBittorrent BitTorrent server + **Command:** ~~~ armbian-config --cmd DOW001 @@ -51,7 +53,9 @@ armbian-config --cmd DOW001 *** -## Remove qBittorrent +## qBittorrent remove +This operation will remove qBittorrent BitTorrent server + **Command:** ~~~ armbian-config --cmd DOW002 @@ -65,17 +69,8 @@ armbian-config --cmd DOW002 *** -## Install Deluge - - -[![Install Deluge](/images/DOW003.png)](#) - - - - -Deluge⁠ is a lightweight, Free Software, cross-platform BitTorrent client. - - +## qBittorrent purge with data folder +This operation will remove qBittorrent BitTorrent data folder **Command:** ~~~ @@ -87,7 +82,34 @@ armbian-config --cmd DOW003 **Status:** Stable - + +*** + +## Deluge BitTorrent server + + +[![Deluge BitTorrent server](/images/DEL001.png)](#) + + + + +Deluge⁠ is a lightweight, Free Software, cross-platform BitTorrent client. + + + +This operation will install BitTorrent server + +**Command:** +~~~ +armbian-config --cmd DEL001 +~~~ + +**Author:** @armbian + +**Status:** Stable + + + === "Access to the web interface" The web interface is accessible via port **8112**: @@ -107,16 +129,18 @@ armbian-config --cmd DOW003 docker logs -f deluge ``` - + *** -## Remove Deluge +## Deluge remove +This operation will remove Deluge BitTorrent server + **Command:** ~~~ -armbian-config --cmd DOW004 +armbian-config --cmd DEL002 ~~~ **Author:** @armbian @@ -127,21 +151,39 @@ armbian-config --cmd DOW004 *** -## Install Transmission +## Deluge purge with data folder +This operation will remove Deluge BitTorrent server data folder - -[![Install Transmission](/images/DOW005.png)](#) - +**Command:** +~~~ +armbian-config --cmd DEL003 +~~~ + +**Author:** @armbian + +**Status:** Stable - + +*** + +## Transmission BitTorrent server + + +[![Transmission BitTorrent server](/images/TRA001.png)](#) + + + + 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. - + + +This operation will install Transmission BitTorrent server **Command:** ~~~ -armbian-config --cmd DOW005 +armbian-config --cmd TRA001 ~~~ **Author:** @armbian @@ -149,7 +191,7 @@ armbian-config --cmd DOW005 **Status:** Stable - + === "Access to the web interface" The web interface is accessible via port **9091**: @@ -170,16 +212,18 @@ armbian-config --cmd DOW005 docker logs -f transmission ``` - + *** -## Remove Transmission +## Transmission remove +This operation will remove Transmission BitTorrent server + **Command:** ~~~ -armbian-config --cmd DOW006 +armbian-config --cmd TRA002 ~~~ **Author:** @armbian @@ -190,21 +234,39 @@ armbian-config --cmd DOW006 *** -## Install SABnzbd +## Transmission purge with data folder +This operation will remove Transmission BitTorrent server data folder - -[![Install SABnzbd](/images/DOW011.png)](#) - +**Command:** +~~~ +armbian-config --cmd TRA003 +~~~ + +**Author:** @armbian + +**Status:** Stable - + +*** + +## SABnzbd newsgroup downloader + + +[![SABnzbd newsgroup downloader](/images/SABN01.png)](#) + + + + 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. - + + +This operation will install SABnzbd newsgroup downloader **Command:** ~~~ -armbian-config --cmd DOW011 +armbian-config --cmd SABN01 ~~~ **Author:** @armbian @@ -212,7 +274,7 @@ armbian-config --cmd DOW011 **Status:** Stable - + === "Access to the web interface" The web interface is accessible via port **8080**: @@ -233,16 +295,18 @@ armbian-config --cmd DOW011 docker logs -f sabnzbd ``` - + *** -## Remove SABnzbd +## SABnzbd remove +This operation will remove SABnzbd newsgroup downloader + **Command:** ~~~ -armbian-config --cmd DOW012 +armbian-config --cmd SABN02 ~~~ **Author:** @armbian @@ -253,21 +317,34 @@ armbian-config --cmd DOW012 *** -## Install Medusa +## SABnzbd purge with data folder +This operation will purge SABnzbd newsgroup data folder - -[![Install Medusa](/images/DOW013.png)](#) - +**Command:** +~~~ +armbian-config --cmd SABN03 +~~~ + +**Author:** @armbian + +**Status:** Stable - + +*** + +## Medusa automatic downloader for TV shows + + 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. - + + +This operation will install Medusa TV shows downloader **Command:** ~~~ -armbian-config --cmd DOW013 +armbian-config --cmd MDS001 ~~~ **Author:** @armbian @@ -275,7 +352,7 @@ armbian-config --cmd DOW013 **Status:** Stable - + === "Access to the web interface" The web interface is accessible via port **8081**: @@ -295,16 +372,18 @@ armbian-config --cmd DOW013 docker logs -f medusa ``` - + *** -## Remove Medusa +## Medusa TV shows downloader remove +This operation will remove Medusa TV shows downloader + **Command:** ~~~ -armbian-config --cmd DOW014 +armbian-config --cmd MDS002 ~~~ **Author:** @armbian @@ -315,21 +394,39 @@ armbian-config --cmd DOW014 *** -## Install Sonarr +## Medusa TV shows downloader purge +This operation will purge Medusa TV shows data folder - -[![Install Sonarr](/images/DOW015.png)](#) - +**Command:** +~~~ +armbian-config --cmd MDS003 +~~~ + +**Author:** @armbian + +**Status:** Stable - + +*** + +## Sonarr automatic downloader for TV shows + + +[![Sonarr automatic downloader for TV shows](/images/SON001.png)](#) + + + + 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. - + + +This operation will install Sonarr PVR for Usenet and BitTorrent **Command:** ~~~ -armbian-config --cmd DOW015 +armbian-config --cmd SON001 ~~~ **Author:** @armbian @@ -337,7 +434,7 @@ armbian-config --cmd DOW015 **Status:** Stable - + === "Access to the web interface" The web interface is accessible via port **8989**: @@ -357,16 +454,18 @@ armbian-config --cmd DOW015 docker logs -f sonarr ``` - + *** -## Remove Sonarr +## Sonarr remove +This operation will remove Sonarr PVR for Usenet and BitTorrent + **Command:** ~~~ -armbian-config --cmd DOW016 +armbian-config --cmd SON002 ~~~ **Author:** @armbian @@ -377,21 +476,39 @@ armbian-config --cmd DOW016 *** -## Install Radarr +## Sonarr purge with data folder +This operation will purge Sonarr PVR for Usenet and BitTorrent purge data folder - -[![Install Radarr](/images/DOW017.png)](#) - +**Command:** +~~~ +armbian-config --cmd SON003 +~~~ + +**Author:** @armbian + +**Status:** Stable - + +*** + +## Radarr automatic downloader for movies + + +[![Radarr automatic downloader for movies](/images/RAD001.png)](#) + + + + Radarr - A fork of Sonarr to work with movies à la Couchpotato. - + + +This operation will install Radarr movie collection manager **Command:** ~~~ -armbian-config --cmd DOW017 +armbian-config --cmd RAD001 ~~~ **Author:** @armbian @@ -399,7 +516,7 @@ armbian-config --cmd DOW017 **Status:** Stable - + === "Access to the web interface" The web interface is accessible via port **7878**: @@ -420,16 +537,18 @@ armbian-config --cmd DOW017 docker logs -f radarr ``` - + *** -## Remove Radarr +## Radarr remove +This operation will remove Radarr movie collection manager + **Command:** ~~~ -armbian-config --cmd DOW018 +armbian-config --cmd RAD002 ~~~ **Author:** @armbian @@ -440,21 +559,39 @@ armbian-config --cmd DOW018 *** -## Install Bazarr +## Radarr purge with data folder +This operation will purge Radarr movie collection manager data folder - -[![Install Bazarr](/images/DOW019.png)](#) - +**Command:** +~~~ +armbian-config --cmd RAD003 +~~~ + +**Author:** @armbian + +**Status:** Stable - + +*** + +## Bazarr automatic subtitles downloader for Sonarr and Radarr + + +[![Bazarr automatic subtitles downloader for Sonarr and Radarr](/images/BAZ001.png)](#) + + + + 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. - + + +This operation will install Bazarr subtitles manager for Sonarr and Radarr **Command:** ~~~ -armbian-config --cmd DOW019 +armbian-config --cmd BAZ001 ~~~ **Author:** @armbian @@ -462,7 +599,7 @@ armbian-config --cmd DOW019 **Status:** Stable - + === "Access to the web interface" The web interface is accessible via port **6767**: @@ -482,16 +619,18 @@ armbian-config --cmd DOW019 docker logs -f bazarr ``` - + *** -## Remove Bazarr +## Bazarr remove +This operation will remove Bazarr subtitles manager for Sonarr and Radarr + **Command:** ~~~ -armbian-config --cmd DOW020 +armbian-config --cmd BAZ002 ~~~ **Author:** @armbian @@ -502,21 +641,39 @@ armbian-config --cmd DOW020 *** -## Install Lidarr +## Bazarr purge with data folder +This operation will purge Bazarr subtitles manager with data folder - -[![Install Lidarr](/images/DOW021.png)](#) - +**Command:** +~~~ +armbian-config --cmd BAZ003 +~~~ + +**Author:** @armbian + +**Status:** Stable - + +*** + +## Lidarr automatic music downloader + + +[![Lidarr automatic music downloader](/images/LID001.png)](#) + + + + 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. - + + +This operation will install Lidarr music collection manager for Usenet and BitTorrent users **Command:** ~~~ -armbian-config --cmd DOW021 +armbian-config --cmd LID001 ~~~ **Author:** @armbian @@ -524,7 +681,7 @@ armbian-config --cmd DOW021 **Status:** Stable - + === "Access to the web interface" The web interface is accessible via port **8686**: @@ -544,16 +701,18 @@ armbian-config --cmd DOW021 docker logs -f lidarr ``` - + *** -## Remove Lidarr +## Lidarr remove +This operation will remove Lidarr + **Command:** ~~~ -armbian-config --cmd DOW022 +armbian-config --cmd LID002 ~~~ **Author:** @armbian @@ -564,21 +723,39 @@ armbian-config --cmd DOW022 *** -## Install Readarr +## Lidarr purge with data folder +This operation will purge Lidarr with data folder - -[![Install Readarr](/images/DOW023.png)](#) - +**Command:** +~~~ +armbian-config --cmd LID003 +~~~ + +**Author:** @armbian + +**Status:** Stable - + +*** + +## Readarr automatic downloader for Ebooks + + +[![Readarr automatic downloader for Ebooks](/images/RDR001.png)](#) + + + + Readarr - Book Manager and Automation (Sonarr for Ebooks) - + + +This operation will install Readarr **Command:** ~~~ -armbian-config --cmd DOW023 +armbian-config --cmd RDR001 ~~~ **Author:** @armbian @@ -586,7 +763,7 @@ armbian-config --cmd DOW023 **Status:** Stable - + === "Access to the web interface" The web interface is accessible via port **8787**: @@ -606,16 +783,18 @@ armbian-config --cmd DOW023 docker logs -f readarr ``` - + *** -## Remove Readarr +## Readarr remove +This operation will remove Readarr + **Command:** ~~~ -armbian-config --cmd DOW024 +armbian-config --cmd RDR002 ~~~ **Author:** @armbian @@ -626,10 +805,26 @@ armbian-config --cmd DOW024 *** -## Install Prowlarr +## Readarr purge with data folder +This operation will purge Readarr with data folder + +**Command:** +~~~ +armbian-config --cmd RDR003 +~~~ + +**Author:** @armbian + +**Status:** Stable + + + +*** + +## Prowlarr index manager and proxy for PVR -[![Install Prowlarr](/images/DOW025.png)](#) +[![Prowlarr index manager and proxy for PVR](/images/DOW025.png)](#) @@ -638,6 +833,8 @@ Prowlarr is a indexer manager/proxy built on the popular arr .net/reactjs base s +This operation will install Prowlarr + **Command:** ~~~ armbian-config --cmd DOW025 @@ -673,7 +870,9 @@ armbian-config --cmd DOW025 *** -## Remove Prowlarr +## Prowlarr remove +This operation will remove Prowlarr + **Command:** ~~~ armbian-config --cmd DOW026 @@ -687,21 +886,39 @@ armbian-config --cmd DOW026 *** -## Jellyseerr install +## Prowlarr purge with data folder +This operation will purge Prowlarr with data folder - -[![Jellyseerr install](/images/DOW040.png)](#) - +**Command:** +~~~ +armbian-config --cmd DOW027 +~~~ + +**Author:** @armbian + +**Status:** Stable - + +*** + +## Jellyseerr Jellyfin/Emby/Plex integration install + + +[![Jellyseerr Jellyfin/Emby/Plex integration install](/images/JEL001.png)](#) + + + + Jellyseerr is a free and open source software application for managing requests for your media library. It is a fork of Overseerr built to bring support for Jellyfin & Emby media servers! - + + +This operation will install Jellyseerr **Command:** ~~~ -armbian-config --cmd DOW040 +armbian-config --cmd JEL001 ~~~ **Author:** @armbian @@ -712,10 +929,12 @@ armbian-config --cmd DOW040 *** -## Jellyseerr remove +## Jellyseerr remove +This operation will remove Jellyseerr + **Command:** ~~~ -armbian-config --cmd DOW041 +armbian-config --cmd JEL002 ~~~ **Author:** @armbian @@ -726,10 +945,12 @@ armbian-config --cmd DOW041 *** -## Jellyseerr purge data folder +## Jellyseerr purge with data folder +This operation will purge Jellyseerr with data folder + **Command:** ~~~ -armbian-config --cmd DOW042 +armbian-config --cmd JEL003 ~~~ **Author:** @armbian diff --git a/docs/User-Guide_Armbian-Software/HomeAutomation.md b/docs/User-Guide_Armbian-Software/HomeAutomation.md index 78e46aec..3c425338 100644 --- a/docs/User-Guide_Armbian-Software/HomeAutomation.md +++ b/docs/User-Guide_Armbian-Software/HomeAutomation.md @@ -1,57 +1,14 @@ -# Home Automation +# Home Automation for monitoring and/or control home appliances *** -## Install openHAB - - -[![Install openHAB](/images/HA001.png)](#) - +## openHAB empowering the smart home +This operation will install openHAB. **Command:** ~~~ -armbian-config --cmd HA001 -~~~ - -**Author:** @armbian - -**Status:** Stable - - - -=== "Access to the web interface" - - The web interface is accessible via port **8444**: - - - URL: `https://:8444` - - Username/Password: Are set at first web interface login - -=== "Directories" - - - Install directory: `/usr/share/openhab` - - Site configuration directory: `/etc/openhab` - - Config file: `/etc/default/openhab` - - Data directory: `/var/lib/openhab` - - See also [openHAB file locations](https://www.openhab.org/docs/installation/linux.html#file-locations). - -=== "View logs" - - ```sh - journalctl -u openhab - ``` - - - - - -*** - -## Remove openHAB -**Command:** -~~~ -armbian-config --cmd HA002 +armbian-config --cmd HAB001 ~~~ **Author:** @armbian @@ -62,64 +19,76 @@ armbian-config --cmd HA002 *** -## Install Home Assistant - - -[![Install Home Assistant](/images/HA003.png)](#) - - - - -Home Assistant is an open source smart home platform that allows you to connect your smart home devices like your TV, fan, cameras, thermostats, lights, and sensors. As a user, you can build intricate automation using Home Assistant's user-friendly, unified web-based user interface. - -Perfect to run on any single board computer with 4 cores and at least 512Mb of memory. Armbian installation is optimised to run from SD/eMMC media, but it is recommended to use SSD. - -=== "Access to the web interface" - - The web interface is accessible via port **8123**: - - - URL: `https://:8123` - - Username/Password: Are set at first web interface login - -=== "Directories" - - Home Assistant on Armbian runs supervised in a Docker container. This secures same functionality as stock HAOS. - - - Config directory: `/usr/share/haos` - - +## openHAB remove +This operation will purge openHAB. **Command:** ~~~ -armbian-config --cmd HA003 +armbian-config --cmd HAB002 ~~~ -**Author:** @igorpecovnik +**Author:** @armbian -**Status:** Preview - - - -|Functionality|HAOS|Armbian with HA| -|:--|:--:|:--:| -|Automations|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|Dashboards|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|Integrations|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|Add-ons|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|One-click updates|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|Backups|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| -|General purpose server|:x:|:white_check_mark:| -|Running on exotic hardware|:x:|:white_check_mark:| - +**Status:** Stable *** -## Remove Home Assistant +## openHAB purge with data folder +This operation will purge openHAB. + **Command:** ~~~ -armbian-config --cmd HA004 +armbian-config --cmd HAB003 +~~~ + +**Author:** @armbian + +**Status:** Stable + + + +*** + +## Home Assistant open source home automation +This operation will install Home Assistant. + +**Command:** +~~~ +armbian-config --cmd HAS001 +~~~ + +**Author:** @igorpecovnik + +**Status:** Preview + + + +*** + +## Home Assistant remove +This operation will remove Home Assistant. + +**Command:** +~~~ +armbian-config --cmd HAS002 +~~~ + +**Author:** @igorpecovnik + +**Status:** Preview + + + +*** + +## Home Assistant purge with data folder +This operation will purge Home Assistant. + +**Command:** +~~~ +armbian-config --cmd HAS003 ~~~ **Author:** @igorpecovnik diff --git a/docs/User-Guide_Armbian-Software/Media.md b/docs/User-Guide_Armbian-Software/Media.md index 802cc7e8..245fc6f6 100644 --- a/docs/User-Guide_Armbian-Software/Media.md +++ b/docs/User-Guide_Armbian-Software/Media.md @@ -1,41 +1,20 @@ -# Media Servers and Editors +# Media servers, organizers and editors *** -## Install Plex Media server -This operation will install Plex Media server. +## Emby organizes video, music, live TV, and photos -**Command:** -~~~ -armbian-config --cmd MED001 -~~~ - -**Author:** @schwar3kat - -**Status:** Stable + +[![Emby organizes video, music, live TV, and photos](/images/MED003.png)](#) + + +Emby organizes video, music, live TV, and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone emby Media Server. -*** + -## Remove Plex Media server -This operation will purge Plex Media server. - -**Command:** -~~~ -armbian-config --cmd MED002 -~~~ - -**Author:** @schwar3kat - -**Status:** Stable - - - -*** - -## Install Emby server This operation will install Emby server. **Command:** @@ -48,11 +27,33 @@ armbian-config --cmd MED003 **Status:** Stable + +=== "Access to the web interface" + + The web interface is accessible via port **8096**: + + - URL: `https://:8096` + +=== "Directories" + + - Install directory: `/armbian/emby` + - Site configuration directory: `/armbian/emby/config` + - Data directory: `/armbian/emby/tvshows` `/armbian/emby/movies` + +=== "View logs" + + ```sh + docker logs -f emby + ``` + + + + *** -## Remove Emby server -This operation will purge Emby server. +## Emby server remove +This operation will remove Emby server **Command:** ~~~ @@ -67,10 +68,24 @@ armbian-config --cmd MED004 *** -## Stirling-PDF Install +## Emby server purge with data folder +**Command:** +~~~ +armbian-config --cmd MED005 +~~~ + +**Author:** @schwar3kat + +**Status:** Stable + + + +*** + +## Stirling PDF tools for viewing and editing PDF files -[![Stirling-PDF Install](/images/MED010.png)](#) +[![Stirling PDF tools for viewing and editing PDF files](/images/MED010.png)](#) @@ -79,6 +94,8 @@ Stirling-PDF is a robust, locally hosted web-based PDF manipulation tool using D +This operation will install Stirling-PDF tools. + **Command:** ~~~ armbian-config --cmd MED010 @@ -112,7 +129,9 @@ armbian-config --cmd MED010 *** -## Stirling-PDF Remove +## Stirling PDF remove +This operation will remove Stirling-PDF tools. + **Command:** ~~~ armbian-config --cmd MED011 @@ -126,7 +145,9 @@ armbian-config --cmd MED011 *** -## Stirling-PDF Purge data folder +## Stirling PDF purge with data folder +This operation will purge Stirling-PDF tools with data folder. + **Command:** ~~~ armbian-config --cmd MED012 @@ -140,10 +161,10 @@ armbian-config --cmd MED012 *** -## Syncthing Install +## Syncthing continuous file synchronization -[![Syncthing Install](/images/MED015.png)](#) +[![Syncthing continuous file synchronization](/images/MED015.png)](#) @@ -188,7 +209,7 @@ armbian-config --cmd MED015 *** -## Syncthing Remove +## Syncthing remove **Command:** ~~~ armbian-config --cmd MED016 @@ -202,7 +223,7 @@ armbian-config --cmd MED016 *** -## Syncthing Purge data folder +## Syncthing purge with data folder **Command:** ~~~ armbian-config --cmd MED017 @@ -216,10 +237,10 @@ armbian-config --cmd MED017 *** -## Nextcloud Install +## Nextcloud content collaboration platform -[![Nextcloud Install](/images/MED020.png)](#) +[![Nextcloud content collaboration platform](/images/MED020.png)](#) @@ -266,7 +287,7 @@ armbian-config --cmd MED020 *** -## Nextcloud Remove +## Nextcloud remove **Command:** ~~~ armbian-config --cmd MED021 @@ -280,7 +301,7 @@ armbian-config --cmd MED021 *** -## Nextcloud Purge data folder +## Nextcloud purge with data folder **Command:** ~~~ armbian-config --cmd MED022 @@ -294,7 +315,7 @@ armbian-config --cmd MED022 *** -## Owncloud Install +## Owncloud share files and folders, easy and secure **Command:** ~~~ armbian-config --cmd MED025 @@ -308,7 +329,7 @@ armbian-config --cmd MED025 *** -## Owncloud Remove +## Owncloud remove **Command:** ~~~ armbian-config --cmd MED026 @@ -322,7 +343,7 @@ armbian-config --cmd MED026 *** -## Owncloud Purge data folder +## Owncloud purge with data folder ownCloud is a free and open-source software project for content collaboration and sharing and syncing of files in distributed and federated enterprise scenarios. diff --git a/docs/User-Guide_Armbian-Software/Monitoring.md b/docs/User-Guide_Armbian-Software/Monitoring.md index a790bb9e..7ef56fee 100644 --- a/docs/User-Guide_Armbian-Software/Monitoring.md +++ b/docs/User-Guide_Armbian-Software/Monitoring.md @@ -1,9 +1,11 @@ -# Monitoring +# Real-time monitoring, collecting metrics, up-time status *** -## Uptime Kuma install +## Uptime Kuma self-hosted monitoring tool +This operation will install Uptime Kuma + **Command:** ~~~ armbian-config --cmd MON001 @@ -43,6 +45,8 @@ armbian-config --cmd MON001 *** ## Uptime Kuma remove +This operation will remove Uptime Kuma + **Command:** ~~~ armbian-config --cmd MON002 @@ -56,7 +60,9 @@ armbian-config --cmd MON002 *** -## Uptime Kuma purge data folder +## Uptime Kuma purge with data folder +This operation will remove Uptime Kuma with data folder + **Command:** ~~~ armbian-config --cmd MON003 @@ -70,10 +76,10 @@ armbian-config --cmd MON003 *** -## Netdata Install +## Netdata - monitoring real-time metrics -[![Netdata Install](/images/MON005.png)](#) +[![Netdata - monitoring real-time metrics](/images/MON005.png)](#) @@ -82,6 +88,8 @@ Netdata is a partially open source tool designed to collect real-time metrics, s +This operation will install Netdata + **Command:** ~~~ armbian-config --cmd MON005 @@ -96,6 +104,8 @@ armbian-config --cmd MON005 *** ## Netdata remove +This operation will remove Netdata + **Command:** ~~~ armbian-config --cmd MON006 @@ -109,7 +119,9 @@ armbian-config --cmd MON006 *** -## Netdata purge data folder +## Netdata purge with data folder +This operation will purge Netdata with data folder + **Command:** ~~~ armbian-config --cmd MON007 diff --git a/docs/User-Guide_Armbian-Software/Netconfig.md b/docs/User-Guide_Armbian-Software/Netconfig.md index 6d661a70..dfca846a 100644 --- a/docs/User-Guide_Armbian-Software/Netconfig.md +++ b/docs/User-Guide_Armbian-Software/Netconfig.md @@ -1,9 +1,9 @@ -# Network tools +# Console network tools for measuring load and bandwidth *** -## Install realtime console network usage monitor (nload) +## nload -realtime console network usage monitor **Command:** ~~~ armbian-config --cmd NET001 @@ -17,7 +17,7 @@ armbian-config --cmd NET001 *** -## Remove realtime console network usage monitor (nload) +## nload - remove **Command:** ~~~ armbian-config --cmd NET002 @@ -31,7 +31,7 @@ armbian-config --cmd NET002 *** -## Install bandwidth measuring tool (iperf3) +## iperf3 bandwidth measuring tool **Command:** ~~~ armbian-config --cmd NET003 @@ -45,7 +45,7 @@ armbian-config --cmd NET003 *** -## Remove bandwidth measuring tool (iperf3) +## iperf3 remove **Command:** ~~~ armbian-config --cmd NET004 @@ -59,7 +59,7 @@ armbian-config --cmd NET004 *** -## Install IP LAN monitor (iptraf-ng) +## iptraf-ng IP LAN monitor **Command:** ~~~ armbian-config --cmd NET005 @@ -73,7 +73,7 @@ armbian-config --cmd NET005 *** -## Remove IP LAN monitor (iptraf-ng) +## iptraf-ng remove **Command:** ~~~ armbian-config --cmd NET006 @@ -87,7 +87,7 @@ armbian-config --cmd NET006 *** -## Install hostname broadcast via mDNS (avahi-daemon) +## avahi-daemon hostname broadcast via mDNS **Command:** ~~~ armbian-config --cmd NET007 @@ -101,7 +101,7 @@ armbian-config --cmd NET007 *** -## Remove hostname broadcast via mDNS (avahi-daemon) +## avahi-daemon remove **Command:** ~~~ armbian-config --cmd NET008 diff --git a/docs/User-Guide_Armbian-Software/WebHosting.md b/docs/User-Guide_Armbian-Software/WebHosting.md index d63d9eb6..282385a8 100644 --- a/docs/User-Guide_Armbian-Software/WebHosting.md +++ b/docs/User-Guide_Armbian-Software/WebHosting.md @@ -1,4 +1,4 @@ -# Web hosting +# Web server, LEMP, reverse proxy, Let's Encrypt SSL **Status:** Stable @@ -62,7 +62,7 @@ armbian-config --cmd SWAG02 *** -## SWAG reverse proxy remove +## SWAG remove **Command:** ~~~ armbian-config --cmd SWAG03 @@ -76,7 +76,7 @@ armbian-config --cmd SWAG03 *** -## SWAG reverse proxy purge data folder +## SWAG purge with data folder **Command:** ~~~ armbian-config --cmd SWAG04 diff --git a/docs/images/BAZ001.png b/docs/images/BAZ001.png new file mode 100644 index 00000000..2f4707b1 Binary files /dev/null and b/docs/images/BAZ001.png differ diff --git a/docs/images/DEL001.png b/docs/images/DEL001.png new file mode 100644 index 00000000..3a00477e Binary files /dev/null and b/docs/images/DEL001.png differ diff --git a/docs/images/JEL001.png b/docs/images/JEL001.png new file mode 100644 index 00000000..6bda23de Binary files /dev/null and b/docs/images/JEL001.png differ diff --git a/docs/images/LID001.png b/docs/images/LID001.png new file mode 100644 index 00000000..33bed87e Binary files /dev/null and b/docs/images/LID001.png differ diff --git a/docs/images/MED001.png b/docs/images/MED001.png new file mode 100644 index 00000000..603e731d Binary files /dev/null and b/docs/images/MED001.png differ diff --git a/docs/images/MED003.png b/docs/images/MED003.png new file mode 100644 index 00000000..a6b258bf Binary files /dev/null and b/docs/images/MED003.png differ diff --git a/docs/images/RAD001.png b/docs/images/RAD001.png new file mode 100644 index 00000000..48d8e5b3 Binary files /dev/null and b/docs/images/RAD001.png differ diff --git a/docs/images/RDR001.png b/docs/images/RDR001.png new file mode 100644 index 00000000..37df9ae3 Binary files /dev/null and b/docs/images/RDR001.png differ diff --git a/docs/images/SABN01.png b/docs/images/SABN01.png new file mode 100644 index 00000000..0908c391 Binary files /dev/null and b/docs/images/SABN01.png differ diff --git a/docs/images/SON001.png b/docs/images/SON001.png new file mode 100644 index 00000000..22932894 Binary files /dev/null and b/docs/images/SON001.png differ diff --git a/docs/images/TRA001.png b/docs/images/TRA001.png new file mode 100644 index 00000000..28ad1c90 Binary files /dev/null and b/docs/images/TRA001.png differ