ProxmoxVE-HelperScripts/README.md

518 lines
14 KiB
Markdown
Raw Normal View History

2021-08-12 12:49:21 -04:00
<h1 align="center" id="heading"> Select a Proxmox Helper Below </h1>
2021-09-30 13:12:34 -04:00
</details>
<details>
<summary>Proxmox VE 7 Post Install</summary>
<h1 align="center" id="heading"> Proxmox VE 7 Post Install </h1>
This script will Disable the Enterprise Repo, Add & Enable the No-Subscription Repo, Add & Disable Test Repo (repo's can be enabled/disabled via the UI in Repositories)
and attempt the *No-Nag* fix.
Run the following in the Proxmox Web Shell. ⚠️ *_PVE7 ONLY_*
```
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/post_install.sh)"
```
It's recommended to update Proxmox after running this script, before adding any VM/CT.
</details>
2021-08-12 10:02:12 -04:00
</details>
2021-08-12 11:04:01 -04:00
<details>
<summary>Home Assistant OS VM</summary>
<h1 align="center" id="heading"> Proxmox VM with Home Assistant OS </h1>
To create a new Proxmox VM with the latest version of Home Assistant OS, run the following from Proxmox web shell
```
2021-08-12 11:06:33 -04:00
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/haos_vm.sh)"
2021-08-12 11:04:01 -04:00
```
### <h3 align="center" id="heading">:zap: Default Settings: 4GB RAM - 32GB Storage - 2vCPU :zap:</h3>
2021-08-12 12:56:21 -04:00
2021-08-12 11:04:01 -04:00
After the script completes, If you're dissatisfied with the default settings, click on the VM, then on the **_Hardware_** tab and change the **_Memory_** and **_Processors_** settings to what you desire. Once all changes have been made, **_Start_** the VM.
</details>
</details>
2021-08-12 10:02:12 -04:00
2021-08-12 12:14:36 -04:00
<details>
<summary>PVE6 Home Assistant Container LXC</summary>
2021-08-28 01:42:42 -04:00
<h1 align="center" id="heading"> Proxmox 6 Home Assistant Container LXC </h1>
2021-08-12 12:14:36 -04:00
To create a new Proxmox 6 Home Assistant Container, run the following from Proxmox web shell.
```
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/pve6_ha_container.sh)"
```
2021-08-20 08:30:12 -04:00
<h3 align="center" id="heading">:zap: Default Settings: 4GB RAM - 16GB Storage - 2vCPU :zap:</h3>
2021-08-12 12:55:48 -04:00
2021-08-12 12:54:15 -04:00
After the script completes, If you're dissatisfied with the default settings, click on the LXC, then on the **_Resources_** tab and change the **_Memory_** and **_Cores_** settings to what you desire. Changes are immediate.
2021-08-12 12:14:36 -04:00
2021-08-12 12:16:25 -04:00
For Home Assistant interface http:// (LXC IP) :8123
For Portainer interface http:// (LXC IP) :9000
Path to HA configuration.yaml
```
/var/lib/docker/volumes/hass_config/_data
2021-08-12 12:18:59 -04:00
```
2021-08-23 05:35:11 -04:00
[To pass through a device for ZHA](https://github.com/tteck/Proxmox/blob/main/Alternative.md#zha-device-pass-through)
2021-08-12 12:18:59 -04:00
2021-08-12 12:14:36 -04:00
</details>
</details>
<details>
<summary>PVE7 Home Assistant Container LXC</summary>
2021-08-28 01:42:42 -04:00
<h1 align="center" id="heading"> Proxmox 7 Home Assistant Container LXC </h1>
2021-08-12 12:14:36 -04:00
To create a new Proxmox 7 Home Assistant Container, run the following from Proxmox web shell.
```
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/pve7_ha_container.sh)"
```
2021-08-12 12:16:25 -04:00
2021-08-20 08:30:12 -04:00
<h3 align="center" id="heading">:zap: Default Settings: 4GB RAM - 16GB Storage - 2vCPU :zap:</h3>
2021-08-12 12:55:48 -04:00
2021-08-12 12:54:15 -04:00
After the script completes, If you're dissatisfied with the default settings, click on the LXC, then on the **_Resources_** tab and change the **_Memory_** and **_Cores_** settings to what you desire. Changes are immediate.
2021-08-12 12:14:36 -04:00
2021-08-12 12:16:25 -04:00
For Home Assistant interface http:// (LXC IP) :8123
For Portainer interface http:// (LXC IP) :9000
Path to HA configuration.yaml
```
/var/lib/docker/volumes/hass_config/_data
2021-08-12 12:18:59 -04:00
```
2021-08-23 05:35:11 -04:00
[To pass through a device for ZHA](https://github.com/tteck/Proxmox/blob/main/Alternative.md#zha-device-pass-through)
2021-08-12 12:17:10 -04:00
2021-08-12 12:14:36 -04:00
</details>
</details>
2021-08-12 10:02:12 -04:00
<details>
<summary>ESPHome LXC</summary>
<h1 align="center" id="heading"> Proxmox ESPHome LXC Container </h1>
To create a new Proxmox ESPHome LXC Container, run the following from Proxmox web shell.
```
2021-08-12 10:26:46 -04:00
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/esphome_container.sh)"
2021-08-12 10:02:12 -04:00
```
2021-08-18 10:30:40 -04:00
<h3 align="center" id="heading">:zap: Default Settings: 1GB RAM - 4GB Storage - 2vCPU :zap:</h3>
2021-08-12 10:02:12 -04:00
2021-09-17 10:30:52 -04:00
For ESPHome interface http:// (LXC IP) :6052
2021-08-12 10:02:12 -04:00
</details>
2021-09-03 15:33:46 -04:00
</details>
<details>
<summary>Nginx Proxy Manager LXC</summary>
<h1 align="center" id="heading"> Proxmox Nginx Proxy Manager LXC Container </h1>
To create a new Proxmox Nginx Proxy Manager LXC Container, run the following from Proxmox web shell.
```
curl -sL https://raw.githubusercontent.com/ej52/proxmox/main/lxc/nginx-proxy-manager/create.sh | bash -s
```
2021-09-03 15:41:25 -04:00
<h3 align="center" id="heading">:zap: Alpine Default Settings: 512MiB RAM - 2GB Storage - 1vCPU :zap:</h3>
2021-09-04 11:03:40 -04:00
____________________________________________________________________________________
2021-09-03 15:38:43 -04:00
2021-09-04 09:18:21 -04:00
Forward port `80` and `443` from your router to your Nginx Proxy Manager LXC IP.
Add the following to your `configuration.yaml` in Home Assistant.
```
http:
use_x_forwarded_for: true
trusted_proxies:
- 192.168.100.27 ###(Nginx Proxy Manager LXC IP)###
```
2021-09-03 15:54:58 -04:00
**Initial Login**
2021-09-03 15:52:58 -04:00
2021-09-03 15:54:58 -04:00
**username**
2021-09-03 15:53:35 -04:00
```
2021-09-03 15:52:58 -04:00
admin@example.com
```
2021-09-03 15:54:58 -04:00
**password**
2021-09-03 15:53:35 -04:00
```
2021-09-03 15:52:58 -04:00
changeme
```
2021-09-03 15:56:06 -04:00
Thanks to [ej52](https://github.com/ej52/proxmox-scripts/blob/main/lxc/nginx-proxy-manager/README.md) for his hard work.
2021-09-03 15:33:46 -04:00
</details>
2021-08-12 10:02:12 -04:00
</details>
<details>
<summary>MQTT LXC</summary>
<h1 align="center" id="heading"> Proxmox MQTT LXC Container </h1>
To create a new Proxmox MQTT LXC Container, run the following in the Proxmox web shell.
```
2021-08-12 10:53:46 -04:00
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/mqtt_container.sh)"
2021-08-12 10:02:12 -04:00
```
2021-08-12 13:15:25 -04:00
<h3 align="center" id="heading">:zap: Default Settings: 512MiB RAM - 2GB Storage - 1vCPU :zap:</h3>
2021-08-12 13:15:56 -04:00
2021-08-12 10:02:12 -04:00
Mosquitto comes with a password file generating utility called mosquitto_passwd.
```
sudo mosquitto_passwd -c /etc/mosquitto/passwd <usr>
```
Password: < password >
Create a configuration file for Mosquitto pointing to the password file we have just created.
```
sudo nano /etc/mosquitto/conf.d/default.conf
```
This will open an empty file. Paste the following into it.
```
allow_anonymous false
2021-08-21 09:22:49 -04:00
persistence true
2021-08-12 10:02:12 -04:00
password_file /etc/mosquitto/passwd
2021-08-21 08:37:19 -04:00
listener 1883
2021-08-12 10:02:12 -04:00
```
Save and exit the text editor with "Ctrl+O", "Enter" and "Ctrl+X".
Now restart Mosquitto server.
```
sudo systemctl restart mosquitto
```
</details>
</details>
<details>
<summary>Node-Red LXC</summary>
<h1 align="center" id="heading"> Proxmox Node-Red LXC Container </h1>
To create a new Proxmox Node-RED LXC Container, run the following in the Proxmox web shell.
```
2021-08-12 10:44:59 -04:00
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/node-red_container.sh)"
2021-08-12 10:02:12 -04:00
```
2021-08-12 13:25:19 -04:00
<h3 align="center" id="heading">:zap: Default Settings: 1GB RAM - 4GB Storage - 1vCPU :zap:</h3>
2021-08-12 10:02:12 -04:00
2021-08-12 11:23:54 -04:00
</details>
</details>
<details>
2021-08-21 20:48:04 -04:00
<summary>Mariadb 10.5 LXC</summary>
2021-08-12 11:23:54 -04:00
2021-08-21 20:30:27 -04:00
<h1 align="center" id="heading"> Proxmox Mariadb 10.5 LXC Container </h1>
2021-08-12 11:23:54 -04:00
To create a new Proxmox Mariadb LXC Container, run the following in the Proxmox web shell.
```
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/mariadb_container.sh)"
```
2021-08-12 13:21:08 -04:00
<h3 align="center" id="heading">:zap: Default Settings: 1GB RAM - 4GB Storage - 1vCPU :zap:</h3>
2021-08-12 11:25:31 -04:00
To enable MariaDB to listen to remote connections, you need to edit your defaults file. To do this, open the console in your MariaDB lxc:
```
2021-08-21 20:30:27 -04:00
nano /etc/mysql/my.cnf
2021-08-12 11:25:31 -04:00
```
2021-08-21 20:30:27 -04:00
Un-comment `port =3306`
Save and exit the editor with "Ctrl+O", "Enter" and "Ctrl+X".
2021-08-12 11:25:31 -04:00
```
2021-08-21 20:30:27 -04:00
nano /etc/mysql/mariadb.conf.d/50-server.cnf
```
Comment `bind-address = 127.0.0.1`
Save and exit the editor with "Ctrl+O", "Enter" and "Ctrl+X".
2021-08-12 11:25:31 -04:00
For new MariaDB installations, the next step is to run the included security script. This script changes some of the less secure default options. We will use it to block remote root logins and to remove unused database users.
Run the security script:
```
sudo mysql_secure_installation
```
2021-08-24 16:39:02 -04:00
Enter current password for root (enter for none): `enter`
2021-08-21 20:32:22 -04:00
2021-08-24 16:39:02 -04:00
Switch to unix_socket authentication [Y/n] `y`
2021-08-21 20:32:22 -04:00
2021-08-24 16:39:02 -04:00
Change the root password? [Y/n] `n`
2021-08-21 20:32:22 -04:00
2021-08-24 16:39:02 -04:00
Remove anonymous users? [Y/n] `y`
2021-08-21 20:32:22 -04:00
2021-08-24 16:39:02 -04:00
Disallow root login remotely? [Y/n] `y`
2021-08-21 20:32:22 -04:00
2021-08-24 16:39:02 -04:00
Remove test database and access to it? [Y/n] `y`
2021-08-21 20:32:22 -04:00
2021-08-24 16:39:02 -04:00
Reload privilege tables now? [Y/n] `y`
2021-08-12 11:25:31 -04:00
2021-08-21 20:30:27 -04:00
We will create a new account called admin with the same capabilities as the root account, but configured for password authentication.
2021-08-12 11:25:31 -04:00
```
sudo mysql
```
Prompt will change to ```MariaDB [(none)]>```
2021-08-21 20:42:54 -04:00
Create a new local admin (Change the username and password to match your preferences)
2021-08-21 20:30:27 -04:00
```
2021-08-21 20:37:57 -04:00
CREATE USER 'admin'@'localhost' IDENTIFIED BY 'password';
2021-08-12 11:25:31 -04:00
```
2021-08-21 21:13:59 -04:00
Give local admin root privileges (Change the username and password to match above)
2021-08-21 20:30:27 -04:00
```
2021-08-21 20:37:57 -04:00
GRANT ALL ON *.* TO 'admin'@'localhost' IDENTIFIED BY 'password' WITH GRANT OPTION;
2021-08-21 20:30:27 -04:00
```
2021-08-27 05:59:26 -04:00
Now, we'll give the user admin root privileges and password-based access that can connect from anywhere on your local area network (LAN), which has addresses in the subnet 192.168.100.0/24. This is an improvement because opening a MariaDB server up to the Internet and granting access to all hosts is bad practice.. Change the **_username_**, **_password_** and **_subnet_** to match your preferences:
2021-08-21 20:30:27 -04:00
```
2021-08-21 20:37:57 -04:00
GRANT ALL ON *.* TO 'admin'@'192.168.100.%' IDENTIFIED BY 'password' WITH GRANT OPTION;
2021-08-12 11:25:31 -04:00
```
Flush the privileges to ensure that they are saved and available in the current session:
```
FLUSH PRIVILEGES;
```
Following this, exit the MariaDB shell:
```
exit
```
Log in as the new database user you just created:
```
mysql -u admin -p
```
Create a new database:
```
CREATE DATABASE homeassistant;
```
2021-08-21 20:30:27 -04:00
Following this, exit the MariaDB shell:
```
exit
```
:warning: Reboot the lxc
2021-08-12 11:25:31 -04:00
Checking status.
```
sudo systemctl status mariadb
```
2021-08-22 05:54:33 -04:00
Change the recorder: `db_url:` in your HA configuration.yaml
2021-08-13 14:45:26 -04:00
2021-08-22 05:55:40 -04:00
Example: `mysql://admin:password@192.168.100.26:3306/homeassistant?charset=utf8mb4`
2021-08-12 11:23:54 -04:00
2021-08-27 18:15:26 -04:00
</details>
2021-08-28 00:49:59 -04:00
2021-08-12 11:47:15 -04:00
</details>
<details>
<summary>PVE6 Zigbee2MQTT LXC</summary>
2021-09-28 18:17:53 -04:00
<h1 align="center" id="heading"> Proxmox 6 Zigbee2MQTT LXC Container </h1>
2021-08-12 11:47:15 -04:00
To create a new Proxmox 6 [Zigbee2MQTT](https://www.zigbee2mqtt.io/) LXC Container, run the following from Proxmox web shell.
```
2021-08-12 11:56:33 -04:00
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/pve6_zigbee2mqtt_container.sh)"
```
2021-08-12 13:57:28 -04:00
<h3 align="center" id="heading">:zap: Default Settings: 1GB RAM - 4GB Storage - 2vCPU :zap:</h3>
2021-08-12 11:56:33 -04:00
Determine the location of your adapter (Run in the zigbee2mqtt console)
```
ls -l /dev/serial/by-id
```
Example Output: ```lrwxrwxrwx 1 root root 13 Jun 19 17:30 usb-1a86_USB_Serial-if00-port0 -> ../../ttyUSB0```
2021-08-22 22:31:19 -04:00
If you are having diffucuilty with device pass through or starting check the [Alternative method](https://github.com/tteck/Proxmox/blob/main/Alternative.md)
2021-08-12 11:56:33 -04:00
:warning: **Before you can start Zigbee2MQTT you need to edit the [configuration.yaml](https://www.zigbee2mqtt.io/information/configuration.html)**
```
nano /opt/zigbee2mqtt/data/configuration.yaml
```
Example:
```
frontend:
port: 9442
homeassistant: true
permit_join: false
mqtt:
base_topic: zigbee2mqtt
server: 'mqtt://192.168.86.224:1883'
user: usr
password: pwd
keepalive: 60
reject_unauthorized: true
version: 4
serial:
port: /dev/serial/by-id/usb-1a86_USB_Serial-if00-port0
advanced:
pan_id: GENERATE
network_key: GENERATE
channel: 20
```
Zigbee2mqtt can be started after completing the configuration by running
```
sudo systemctl start zigbee2mqtt
```
2021-08-13 14:14:34 -04:00
To start Zigbee2MQTT automatically on boot
```
sudo systemctl enable zigbee2mqtt.service
```
2021-08-23 06:37:41 -04:00
To update Zigbee2Mqtt
2021-08-23 06:09:35 -04:00
```
cd /opt/zigbee2mqtt
bash update.sh
```
2021-08-12 11:56:33 -04:00
</details>
</details>
<details>
<summary>PVE7 Zigbee2MQTT LXC</summary>
2021-09-28 18:17:53 -04:00
<h1 align="center" id="heading"> Proxmox 7 Zigbee2MQTT LXC Container </h1>
2021-08-12 11:56:33 -04:00
To create a new Proxmox 7 [Zigbee2MQTT](https://www.zigbee2mqtt.io/) LXC Container, run the following from Proxmox web shell.
```
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/pve7_zigbee2mqtt_container.sh)"
2021-08-12 11:47:15 -04:00
```
2021-08-12 13:57:28 -04:00
<h3 align="center" id="heading">:zap: Default Settings: 1GB RAM - 4GB Storage - 2vCPU :zap:</h3>
2021-08-12 11:47:15 -04:00
Determine the location of your adapter (Run in the zigbee2mqtt console)
```
ls -l /dev/serial/by-id
```
Example Output: ```lrwxrwxrwx 1 root root 13 Jun 19 17:30 usb-1a86_USB_Serial-if00-port0 -> ../../ttyUSB0```
2021-08-22 22:34:15 -04:00
If you are having diffucuilty with device pass through or starting check the [Alternative method](https://github.com/tteck/Proxmox/blob/main/Alternative.md)
:warning: **Before you can start Zigbee2MQTT you need to edit the [configuration.yaml](https://www.zigbee2mqtt.io/information/configuration.html)**
2021-08-12 11:47:15 -04:00
```
nano /opt/zigbee2mqtt/data/configuration.yaml
```
Example:
```
frontend:
port: 9442
homeassistant: true
permit_join: false
mqtt:
base_topic: zigbee2mqtt
server: 'mqtt://192.168.86.224:1883'
user: usr
password: pwd
keepalive: 60
reject_unauthorized: true
version: 4
serial:
port: /dev/serial/by-id/usb-1a86_USB_Serial-if00-port0
advanced:
pan_id: GENERATE
network_key: GENERATE
channel: 20
```
Zigbee2mqtt can be started after completing the configuration by running
```
sudo systemctl start zigbee2mqtt
```
2021-08-13 14:13:00 -04:00
To start Zigbee2MQTT automatically on boot
```
sudo systemctl enable zigbee2mqtt.service
```
2021-08-23 06:37:41 -04:00
To update Zigbee2Mqtt
2021-08-23 06:09:35 -04:00
```
cd /opt/zigbee2mqtt
bash update.sh
```
2021-08-12 10:02:12 -04:00
</details>
2021-08-12 15:36:21 -04:00
</details>
<details>
2021-09-28 18:17:53 -04:00
<summary>Base Debian 10+ LXC</summary>
2021-08-12 15:36:21 -04:00
<h1 align="center" id="heading"> Proxmox Debian 10 LXC Container </h1>
2021-08-12 15:38:04 -04:00
To create a new Proxmox Debian 10 (curl. sudo, auto login) LXC Container, run the following in the Proxmox web shell.
2021-08-12 15:36:21 -04:00
```
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/debian10_container.sh)"
```
<h3 align="center" id="heading">:zap: Default Settings: 512MiB RAM - 2GB Storage - 1vCPU :zap:</h3>
After the script completes, If you're dissatisfied with the default settings, click on the LXC, then on the **_Resources_** tab and change the **_Memory_** and **_Cores_** settings to what you desire. Changes are immediate.
</details>
2021-08-19 08:37:01 -04:00
</details>
<details>
2021-09-28 18:17:53 -04:00
<summary>Base Debian 11+ LXC</summary>
2021-08-19 08:37:01 -04:00
<h1 align="center" id="heading"> Proxmox Debian 11 LXC Container </h1>
To create a new Proxmox Debian 11 (curl. sudo, auto login) LXC Container, run the following in the Proxmox web shell.
```
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/debian11_container.sh)"
```
<h3 align="center" id="heading">:zap: Default Settings: 512MiB RAM - 2GB Storage - 1vCPU :zap:</h3>
After the script completes, If you're dissatisfied with the default settings, click on the LXC, then on the **_Resources_** tab and change the **_Memory_** and **_Cores_** settings to what you desire. Changes are immediate.
</details>
2021-09-27 09:47:47 -04:00
</details>
<details>
2021-09-30 13:12:34 -04:00
<summary>Pi-hole LXC</summary>
2021-09-27 09:47:47 -04:00
2021-09-30 13:12:34 -04:00
<h1 align="center" id="heading"> Pi-hole LXC </h1>
2021-09-27 09:47:47 -04:00
2021-09-30 13:12:34 -04:00
To create a new Proxmox Pi-hole LXC, run the following in the Proxmox web shell.
2021-09-27 09:47:47 -04:00
```
2021-09-30 13:12:34 -04:00
bash -c "$(wget -qLO - https://raw.githubusercontent.com/tteck/Proxmox/main/pihole_container.sh)"
2021-09-27 09:47:47 -04:00
```
2021-09-30 13:12:34 -04:00
<h3 align="center" id="heading">:zap: Default Settings: 512MiB RAM - 2GB Storage - 1vCPU :zap:</h3>
To set your password (Run in the pi-hole console)
2021-09-27 09:47:47 -04:00
2021-09-30 13:12:34 -04:00
```
pihole -a -p
```
2021-09-27 09:47:47 -04:00
</details>
2021-09-30 13:12:34 -04:00