DietPi-Software | Details for ALL installation options

[Fourdee]

Grafana:
The open platform for beautiful analytics and monitoring.

This installation and documentation was possible, thanks to @marcobrianza
NB: Grafana binaries are specific to the CPU architecture, therefore, swapping SD cards between RPi 1 <> 2+, is not recommended

Pre-req:
A database server is required for Grafana. As Grafana offers many options (InfluxDB/MySQL), we have not automatically installed either as manual configuration may be preferred.
However, we highly recommend installing InfluxDB:

• dietpi-software install 74

Then follow the database creation guide here: viewtopic.php?f=8&t=5&p=12523#p12523

Access web interface:

• URL = http://192.168.0.100:3001 (v6.19 and lower, port = 3000)
• User = admin
• Password = dietpi

Usage Information:
If you have created a database as per the InfluxDB online doc, please follow these instructions:

• From the Home Dashboard click Add data source, then enter the following information:
  • Type = InfluxDB
  • URL = http://localhost:8086
  • Database = mydb
  • User = test_user
  • Password = test_password01
  • Leave the remaining items with the default values.
• Click Save & Test
• From the Home Dashboard click New dashboard
  • click Graph
  • Click the example graph
  • Press e to edit the Data Source and the custom query

Install information:

• The data location for Grafana is stored/symlinked to the DietPi userdata directory: /mnt/dietpi_userdata/grafana
  
  
  >> Return to DietPi-Software List

[Fourdee]

Ubooquity:
Ubooquity is a free home server for your comics and ebooks library, with remote web interface viewing.

Access Web Interface:

• Admin page = http://192.168.0.100:2038/admin
• Library view page = http://192.168.0.100:2039

Transfer ebooks/comics to your device:
Make sure you have one of DietPi's File Servers installed.

• Use the following folders = /mnt/dietpi_userdata/ebooks and /mnt/dietpi_userdata/comics
• Then use the admin page, to set the above locations for ebook and comic storage
• Run a scan in the admin page to update the database

>> Return to DietPi-Software List

[Fourdee]

Roon Extension Manager:
At startup the Roon Extension Manager accesses a repository containing the community developed extensions. Via Settings->Extensions within Roon the repository can be viewed and an extension can be selected to perform a certain action.
Many thanks to @JanKoudijs for contributing this into DietPi

Details and usage information:
https://community.roonlabs.com/t/roon-e ... -7-0/26632

[Fourdee]

Lidarr:
Automatically download your favorite music.

NB: A download client is required:
- Transmission BitTorrent server is recommended to enable automatic downloads.

Access web interface:

• url = http://192.168.0.100:8686

First Run Setup:
Before you can add music, you'll need to select a search indexer to use from the web interface:

• Simply goto Settings > Indexers then choose at least one indexer.

Setup your download client:

• Simply goto Settings > Download Client , select your installed download client and enter required credentials.

Setup file creation mask:

• If you require write access from other applications (eg: Plex subtitle downloads), you'll also need to set the file/folder creation mask to allow this.
  • In the the web interface, select Settings
  • Toggle to Advanced settings slider (enable it)
  • Under Media Management tab, scroll down to the bottom of the page under Permissions, set the following values:

    

  • Save changes

Add a music:

• Simply select Artist > Add New
• Type a name of the artist you wish to find
• Once found, under root folder, use the following location /mnt/dietpi_userdata/downloads
• Change any other settings as required, then select Add

Link databases to RAM:
Link the Lidarr info/settings database to RAM to increase access performance, reduce disk I/O and avoide constant external HDD spinning due to the very regular access to these files: viewtopic.php?f=8&t=5828

Recommended: Protect your privacy with a VPN:
Although we enable forced encryption on all our BitTorrent clients, if you wish to ensure complete privacy and peice of mind for all your downloaded content, using a VPN is critical.

• We highly recommend NordVPN as it offers unlimited bandwidth, zero logging and upto 6 devices on 1 account.
• How to: connect using DietPi-NordVPN client

>> Return to DietPi-Software List

[Fourdee]

[email protected]:
[email protected] is a project focused on disease research. The problems we’re solving require so many computer calcul­ations – and we need your help to find the cures!

By default, our installation will add you to the DietPi team group, however, you can change this in the web interface at any time.

Access Web Interface:

• URL = http://192.168.0.100:7396

View/Edit Config file:

• Stop services with dietpi-services stop
• Edit /mnt/dietpi_userdata/fahclient/config.xml
• Save changes and restart services with dietpi-services start
• Only a small percentage of my CPU cores/processing is being used?
  • This is a known limitation and depends on the WU job and how many cores it will support.
  • You can however, increase the number of jobs that run on the system to compensate. The below example config has 3 job slots, ideal for a 6 core CPU (allowing 2 CPU cores per job slot):

    Code: Select all

    <config>
      <!-- Slot Control -->
      <power v='FULL'/>
    
      <!-- User Information -->
      <user v='Fourdee'/>
    
      <!-- Folding Slots -->
      <slot id='0' type='CPU'/>
      <slot id='1' type='CPU'/>
      <slot id='2' type='CPU'/>
    </config>

View Log file:

• cat /var/log/fahclient.log

[MichaIng]

FreshRSS:
A self-hosted RSS feed aggregator

Access web interface:

• URL = http://192.168.0.100/freshrss
• User = dietpi
• Password = dietpi

How do I use this software?
Please refer to the official online documentation for usage information:
https://freshrss.github.io/FreshRSS/en/ ... steps.html

[Fourdee]

myMPD
A lightweight, bare-bones, no frills Hifi music player with a web based interface. myMPD is a front end for MPD, and a recent fork of YMPD.

Also installs:

• MPD (music player daemon)

Access web interface:

• url = http://192.168.0.100:1333

Install Notes:
We have disabled SSL and its redirect by default with the DietPi install. This is to prevent redirects to the hostname.
To re-enable the SSL connection and redirect option:

• Edit /etc/mympd.conf
• Replace ssl = false with ssl = true
• Save changes and exit
• Restart services with dietpi-services restart
• Use the same URL address above, it will redirect to HTTPS during connection

Transfer/Add Music:

• Make sure you have one of DietPi's File Servers installed.
• Folders used:
  • local = /mnt/dietpi_userdata/Music
  • accessed from fileserver = /Music

Refresh Music Files / Database:
Simply select the Update database option from the settings menu in myMPD.

DietPi-JustBoom control panel: Tweak audio options on the fly
Simply run dietpi-justboom from the command line to launch


>> Return to DietPi-Software List

[MichaIng]

Nextcloud Talk:
Video calls hosted on your own Nextcloud instance. The TURN server "coturn" will be installed and configured as well to allow reliable video calls through outside the local network, NAT and firewall setups.

Also installs:

• Nextcloud
• coturn

Install Notes:

• During installation you will be asked to enter the external server domain and a port, that you want to use for the coturn TURN server. Note that you need to forward the chosen port and/or open it in your firewall.
• If HTTPS was or is enabled via dietpi-letsencrypt, coturn will be configured to use the LetsEncrypt certificates for TLS connections on the chosen TURN server port automatically.
• coturn by default will listen to non-TLS requests as well on the port configured in /etc/turnserver.conf. You can force TLS/control this by switching port forwarding in your router and/or opening/dropping ports in your firewall.
• coturn logging by default is disabled via /etc/default/coturn command arguments, since it is very verbose and produces much disk I/O. You can enable and configure logging via /etc/turnserver.conf, if required.

>> Return to DietPi-Software List

[Fourdee]

DietPi-NordVPN:
DietPi-NordVPN is a combination of OpenVPN installation and DietPi front end GUI. Allowing all NordVPN users to quickly and easily connect to any NordVPN server in TCP or UDP, using only open source software.

Requires NordVPN Subscription:
Although we enable forced encryption on all our BitTorrent clients, if you wish to ensure complete privacy and peice of mind for all your downloaded content, using a VPN is critical.
NordVPN. Offers unlimited bandwidth, zero logging and upto 6 devices on 1 account.

Usage:
Once installed using dietpi-software:

• Simply run dietpi-nordvpn to use the GUI, allowing you to setup your connection.
• DietPi will also automatically start and connect the VPN during system boot.

>> Return to DietPi-Software List

[MichaIng]

WireGuard:
WireGuard® is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache.



Usage:
When installing using dietpi-software, you can choose whether to install WireGuard as VPN client or server.

When installing as VPN server:

• You are asked to enter your public IP/domain and the port, on which the VPN server should be available. Remember to open/forward the port through NAT.
• During install, a client config will be automatically created as well at: /etc/wireguard/wg0-client.conf
• Configure the client config to your needs, it contains some informational comments. By default it will pass all clients network traffic through the VPN tunnel, including DNS requests which will be resolved by the servers DNS resolver.
  If you e.g. want to use the servers Pi-hole instance on the client only, but keep all other traffic outside the VPN tunnel, you would edit the following values:
  DNS = 192.168.0.100
  AllowedIPs = 192.168.0.100/32 (where the IP needs to match your DietPi servers local IP)
• If your client is another Linux machine with iptables installed, you can uncomment the two kill switch lines to have all network traffic automatically disable, when VPN connection is lost.
• If your client is a mobile phone with WireGuard app installed, you can simply apply the config by printing a QR code onto the servers terminal via: grep -v '^#' /etc/wireguard/wg0-client.conf | qrencode -t ansiutf8
• To allow VPN clients accessing your local Pi-hole instance, you need to allow DNS requests from all network interfaces: pihole -a -i local

Adding multiple clients:

• Navigate to the servers WireGuard config dir: cd /etc/wireguard
• Create a second client key pair:

  Code: Select all

  umask 0077
  wg genkey > client2_private.key
  wg pubkey < client2_private.key > client2_public.key
  umask 0022

• Clone and configure the client config:

  Code: Select all

  cp -a wg0-client.conf wg0-client2.conf
  G_CONFIG_INJECT 'Address = ' 'Address = 10.9.0.3/24' wg0-client2.conf
  G_CONFIG_INJECT 'PrivateKey = ' "PrivateKey = $(<client2_private.key)" wg0-client2.conf

• Configure wg0.conf (server config) so the last lines match:

  Code: Select all

  [Peer]
  PublicKey = <paste content of client2_public.key here>
  AllowedIPs = 10.9.0.3/32

• Restart the VPN server (systemctl restart [email protected]) and apply wg0-client2.conf to your second VPN client as you did for the first before.
• Repeat similar for third, fourth, ... VPN client.

When installing as VPN client:

• Usually the VPN provider will have install instructions and ship a config file.
• If the you want to connect to another DietPi machine, use the generated /etc/wireguard/wg0-client.conf as mentioned above.
• If no WireGuard (auto)start instructions are included, but you require it, please do the following:
  • Check for the created config file/interface name: ls -Al /etc/wireguard/
    It has a .conf file ending, lets assume: wg0-client.conf
  • To start the VPN interface, run: systemctl start [email protected]
  • To autostart the VPN interface on boot, run: systemctl enable [email protected]
  • To disable autostart again, run: systemctl disable [email protected]

NB:

• The WireGuard kernel module needs to rebuild whenever the kernel is updated. On most devices this will be done automatically, when the kernel (+headers) is updated via APT package, which then usually triggers the module rebuild.
• If you update the kernel outside of APT, via source build or commands like rpi-update, assure that matching kernel headers are installed as well and rebuild the WireGuard module via: dpkg-reconfigure wireguard-dkms

>> Return to DietPi-Software List