Skip to content

Commit de7dbba

Browse files
authored
Revise installation section in README.md
1 parent c626abf commit de7dbba

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,36 @@ A modern web-based management interface for Proxmox VE (PVE) helper scripts. Thi
4242

4343
## 🚀 Installation
4444

45-
You can use the provided ```install.sh``` file in the root directory of this repository or follow the steps below to install manually. The install script takes care of all prerequisits.
45+
You can either install automatically via the provided installer script or do a manual setup.
46+
47+
### Option 1: Install via Bash (Recommended)
48+
49+
Run this command directly on your Proxmox VE host:
50+
51+
```bash
52+
bash -c "$(curl -fsSL https://raw.githubusercontent.com/michelroegl-brunner/PVESciptslocal/main/installer.sh)"
53+
```
54+
55+
## The script will:
56+
- Verify that you are running on Proxmox VE
57+
- Check and install git and Node.js 24.x if missing
58+
- Clone the repository into /opt/PVESciptslocal (or your chosen path)
59+
- Run npm install and build the project
60+
- Set up .env from .env.example if missing
61+
- Create a systemd service (pvescriptslocal.service) for easy start/stop management
62+
63+
After installation, the app will be accessible at:
64+
👉 http://<YOUR_PVE_IP>:3000
65+
66+
You can manage the service with:
67+
```bash
68+
systemctl start pvescriptslocal
69+
systemctl stop pvescriptslocal
70+
systemctl status pvescriptslocal
71+
```
72+
73+
74+
### Option 2: Manual Installation
4675

4776
### 1. Clone the Repository
4877

0 commit comments

Comments
 (0)