Skip to content

Commit b77554a

Browse files
Update Readme
1 parent d927180 commit b77554a

File tree

1 file changed

+6
-36
lines changed

1 file changed

+6
-36
lines changed

README.md

Lines changed: 6 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A modern web-based management interface for Proxmox VE (PVE) helper scripts. Thi
77
This application can be deployed in multiple ways to suit different environments:
88

99
- **📦 Debian LXC Container**: Deploy inside a Debian LXC container for better isolation
10-
- **⚡ Quick Install**: Use the automated `install.sh` script for easy setup or use the helper-script.
10+
- **🔧 Helper Script**: Use the automated helper script for easy setup
1111

1212
All deployment methods provide the same functionality and web interface.
1313

@@ -68,32 +68,7 @@ All deployment methods provide the same functionality and web interface.
6868

6969
Choose the installation method that best fits your environment:
7070

71-
### Option 1: Quick Install with install.sh (Recommended for Proxmox Host)
72-
73-
Run this command directly on your Proxmox VE host or on any Debian based lxc:
74-
75-
```bash
76-
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE-Local/main/install.sh)"
77-
```
78-
79-
**What the script does:**
80-
- ✅ Installs required dependencies (build-essential, git, Node.js 24.x)
81-
- ✅ Clones the repository into `/opt/PVESciptslocal` (or your chosen path)
82-
- ✅ Runs npm install and builds the project
83-
- ✅ Sets up `.env` from `.env.example` if missing
84-
- ✅ Creates database directory (`data/`) for SQLite storage
85-
- ✅ Creates a systemd service (`pvescriptslocal.service`) for easy management
86-
87-
**After installation:**
88-
- 🌐 Access the app at: `http://<YOUR_LXC_IP>:3000`
89-
- 🔧 Manage the service with:
90-
```bash
91-
systemctl start pvescriptslocal
92-
systemctl stop pvescriptslocal
93-
systemctl status pvescriptslocal
94-
```
95-
96-
### Option 2: Debian LXC Container Installation
71+
### Option 1: Debian LXC Container Installation
9772

9873
For better isolation and security, you can run PVE Scripts Local inside a Debian LXC container:
9974

@@ -102,13 +77,8 @@ For better isolation and security, you can run PVE Scripts Local inside a Debian
10277
```bash
10378
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/debian.sh)"
10479
```
105-
Then run the installer:
106-
107-
```bash
108-
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE-Local/main/install.sh)"
109-
```
11080

111-
#### Step 2: Install Dependencies in Container when installer is not used
81+
#### Step 2: Install Dependencies in Container
11282
```bash
11383
# Enter the container
11484
pct enter 100
@@ -143,14 +113,14 @@ chmod 755 data
143113
npm start
144114

145115
# Or create a systemd service (optional)
146-
# Follow the same systemd setup as the install.sh script
116+
# Create systemd service for easy management
147117
```
148118

149119
**Access the application:**
150120
- 🌐 Container IP: `http://<CONTAINER_IP>:3000`
151121
- 🔧 Container management: `pct start 100`, `pct stop 100`, `pct status 100`
152122

153-
### Option 3: Use the helper script
123+
### Option 2: Use the helper script
154124

155125
This creates the LXC and installs the APP for you.
156126

@@ -169,7 +139,7 @@ The web interface is accessible regardless of your deployment method:
169139

170140
### 2. Service Management
171141

172-
#### For install.sh installations or helper-scripts variant(systemd service):
142+
#### For helper-script installations (systemd service):
173143
```bash
174144
# Start the service
175145
systemctl start pvescriptslocal

0 commit comments

Comments
 (0)