11# PVE Scripts Local 🚀
22
3- A modern web-based management interface for Proxmox VE (PVE) helper scripts. This tool provides a user-friendly way to discover, download, and execute community-sourced Proxmox scripts locally with real-time terminal output streaming.
3+ A modern web-based management interface for Proxmox VE (PVE) helper scripts. This tool provides a user-friendly way to discover, download, and execute community-sourced Proxmox scripts locally with real-time terminal output streaming. No more need for curl -> bash calls, it all happens in your enviroment.
44
55## 🎯 Deployment Options
66
77This application can be deployed in multiple ways to suit different environments:
88
9- - ** 🐧 Proxmox Host** : Run directly on your Proxmox VE host system
109- ** 📦 Debian LXC Container** : Deploy inside a Debian LXC container for better isolation
11- - ** ⚡ Quick Install** : Use the automated ` install.sh ` script for easy setup
10+ - ** ⚡ Quick Install** : Use the automated ` install.sh ` script for easy setup or use the helper-script.
1211
1312All deployment methods provide the same functionality and web interface.
1413
@@ -57,9 +56,6 @@ All deployment methods provide the same functionality and web interface.
5756- ** Proxmox VE environment** (host or access to Proxmox cluster)
5857- ** SQLite** (included with Node.js better-sqlite3 package)
5958
60- ### For Proxmox Host Installation
61- - ** build-essentials** : ` apt install build-essential `
62- - Direct access to Proxmox host system
6359
6460### For Debian LXC Container Installation
6561- ** Debian LXC container** (Debian 11+ recommended)
@@ -68,9 +64,6 @@ All deployment methods provide the same functionality and web interface.
6864- Network access from container to Proxmox host
6965- Optional: Privileged container for full Proxmox integration
7066
71- ### For Quick Install (install.sh)
72- - ** Proxmox VE host** (script automatically detects and configures)
73- - Internet connectivity for downloading dependencies
7467
7568## 🚀 Installation
7669
@@ -81,7 +74,7 @@ Choose the installation method that best fits your environment:
8174Run this command directly on your Proxmox VE host or on any Debian based lxc:
8275
8376``` bash
84- bash -c " $( curl -fsSL https://raw.githubusercontent.com/michelroegl-brunner/PVESciptslocal /main/install.sh) "
77+ bash -c " $( curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE-Local /main/install.sh) "
8578```
8679
8780** What the script does:**
@@ -93,7 +86,7 @@ bash -c "$(curl -fsSL https://raw.githubusercontent.com/michelroegl-brunner/PVES
9386- ✅ Creates a systemd service (` pvescriptslocal.service ` ) for easy management
9487
9588** After installation:**
96- - 🌐 Access the app at: ` http://<YOUR_PVE_OR_LXC_IP >:3000 `
89+ - 🌐 Access the app at: ` http://<YOUR_LXC_IP >:3000 `
9790- 🔧 Manage the service with:
9891 ``` bash
9992 systemctl start pvescriptslocal
@@ -113,7 +106,7 @@ bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/Proxmo
113106Then run the installer:
114107
115108``` bash
116- bash -c " $( curl -fsSL https://raw.githubusercontent.com/michelroegl-brunner/PVESciptslocal /main/install.sh) "
109+ bash -c " $( curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE-Local /main/install.sh) "
117110```
118111
119112#### Step 2: Install Dependencies in Container when installer is not used
@@ -132,15 +125,13 @@ apt install -y nodejs
132125#### Step 3: Clone and Setup Application
133126``` bash
134127# Clone the repository
135- git clone https://github.com/michelroegl-brunner/PVESciptslocal .git /opt/PVESciptslocal
136- cd /opt/ PVESciptslocal
128+ git clone https://github.com/community-scripts/ProxmoxVE-Local .git /opt/PVESciptslocal
129+ cd PVESciptslocal
137130
138131# Install dependencies and build
139132npm install
140- npm run build
141-
142- # Setup environment
143133cp .env.example .env
134+ npm run build
144135
145136# Create database directory
146137mkdir -p data
@@ -160,82 +151,26 @@ npm start
160151- 🌐 Container IP: ` http://<CONTAINER_IP>:3000 `
161152- 🔧 Container management: ` pct start 100 ` , ` pct stop 100 ` , ` pct status 100 `
162153
163- ### Option 3: Manual Installation (Proxmox Host)
154+ ### Option 3: Use the helper script
164155
165- #### Step 1: Clone the Repository
166- ``` bash
167- git clone https://github.com/michelroegl-brunner/PVESciptslocal.git
168- cd PVESciptslocal
169- ```
156+ This creates the LXC and installs the APP for you.
170157
171- #### Step 2: Install Dependencies
172158``` bash
173- npm install
159+ bash -c " $( curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/pve-scripts-local.sh ) "
174160```
175161
176- #### Step 3: Environment Configuration
177- ``` bash
178- cp .env.example .env
179- # Edit .env file with your specific settings if needed
180- ```
181-
182- #### Step 4: Database Setup
183- ``` bash
184- # Create database directory
185- mkdir -p data
186- chmod 755 data
187- ```
188-
189- #### Step 5: Build and Start
190- ``` bash
191- # Production mode
192- npm run build
193- npm start
194-
195- # Development mode
196- npm run dev:server
197- ```
198-
199- ** Access the application:**
200- - 🌐 Available at: ` http://<YOUR_IP>:3000 `
201-
202- ## 📝 LXC Container Specific Notes
203-
204- ### Container Requirements
205- - ** OS** : Debian 11+ (Debian 12 recommended)
206- - ** Resources** : Minimum 2GB RAM, 4GB storage
207- - ** Network** : Bridge connection to Proxmox network
208- - ** Privileges** : Unprivileged containers work, but privileged containers provide better Proxmox integration
209-
210- ### Container Configuration Tips
211- - ** Privileged Container** : Use ` --unprivileged 0 ` for full Proxmox API access
212- - ** Resource Allocation** : Allocate at least 2 CPU cores and 2GB RAM for optimal performance
213- - ** Storage** : Use at least 8GB for the container to accommodate Node.js and dependencies
214- - ** Network** : Ensure the container can reach the Proxmox host API
215-
216- ### Security Considerations
217- - ** Unprivileged Containers** : More secure but may have limited Proxmox functionality
218- - ** Privileged Containers** : Full Proxmox access but less secure isolation
219- - ** Network Access** : Ensure proper firewall rules for the container
220-
221- ### Troubleshooting LXC Installation
222- - ** Permission Issues** : Ensure the container has proper permissions for Proxmox API access
223- - ** Network Connectivity** : Verify the container can reach the Proxmox host
224- - ** Resource Limits** : Check if the container has sufficient resources allocated
225-
226162## 🎯 Usage
227163
228164### 1. Access the Web Interface
229165
230166The web interface is accessible regardless of your deployment method:
231167
232- - ** Proxmox Host Installation** : ` http://<PROXMOX_HOST_IP>:3000 `
233168- ** LXC Container Installation** : ` http://<CONTAINER_IP>:3000 `
234169- ** Custom Installation** : ` http://<YOUR_IP>:3000 `
235170
236171### 2. Service Management
237172
238- #### For install.sh installations (systemd service):
173+ #### For install.sh installations or helper-scripts variant (systemd service):
239174``` bash
240175# Start the service
241176systemctl start pvescriptslocal
@@ -253,20 +188,6 @@ systemctl enable pvescriptslocal
253188journalctl -u pvescriptslocal -f
254189```
255190
256- #### For LXC container installations:
257- ``` bash
258- # Container management
259- pct start < container_id> # Start container
260- pct stop < container_id> # Stop container
261- pct status < container_id> # Check container status
262-
263- # Access container shell
264- pct enter < container_id>
265-
266- # Inside container - start application
267- cd /opt/PVESciptslocal
268- npm start
269- ```
270191
271192#### For manual installations:
272193``` bash
@@ -289,7 +210,7 @@ npm run build
289210### 4. Download Scripts
290211
291212- Click on any script card to view details
292- - Use the "Download" button to fetch scripts from GitHub
213+ - Use the "Download" button to fetch scripts from the ProxmoxVE GitHub
293214- Downloaded scripts are stored locally in the ` scripts/ ` directory
294215
295216### 5. Execute Scripts
@@ -379,23 +300,6 @@ npm run dev:server
379300
380301This project is licensed under the MIT License - see the [ LICENSE] ( LICENSE ) file for details.
381302
382- ### Logs
383-
384- - Server logs: Check console output or ` server.log `
385- - Script execution: View in web terminal
386-
387- ## 🎯 Quick Start Summary
388-
389- Choose your preferred deployment method:
390-
391- | Method | Best For | Command |
392- | --------| ----------| ---------|
393- | ** Quick Install** | Proxmox hosts or Debian LXC, easy setup | ` bash -c "$(curl -fsSL https://raw.githubusercontent.com/michelroegl-brunner/PVESciptslocal/main/install.sh)" ` |
394- | ** LXC Container** | Better isolation, security | Create Debian LXC → Install dependencies → Clone repo → ` npm start ` |
395- | ** Manual Install** | Custom setups, development | ` git clone ` → ` npm install ` → ` npm run build ` → ` npm start ` |
396-
397- All methods provide the same web interface at ` http://<IP>:3000 ` with full Proxmox script management capabilities.
398-
399303---
400304
401- ** Note** : This is alpha software. Use with caution in production environments and always backup your Proxmox configuration before running scripts.
305+ ** Note** : This is beat software. Use with caution in production environments and always backup your Proxmox configuration before running scripts.
0 commit comments