You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+243Lines changed: 243 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -210,6 +210,249 @@ The application uses SQLite for storing server configurations:
210
210
-**Backup**: Copy `data/settings.db` to backup your server configurations
211
211
-**Reset**: Delete `data/settings.db` to reset all server configurations
212
212
213
+
## 📖 Feature Guide
214
+
215
+
This section provides detailed information about the application's key features and how to use them effectively.
216
+
217
+
### Server Settings
218
+
219
+
Manage your Proxmox VE servers and configure connection settings.
220
+
221
+
**Adding PVE Servers:**
222
+
-**Server Name**: A friendly name to identify your server
223
+
-**IP Address**: The IP address or hostname of your PVE server
224
+
-**Username**: PVE user account (usually root or a dedicated user)
225
+
-**SSH Port**: Default is 22, change if your server uses a different port
226
+
227
+
**Authentication Types:**
228
+
-**Password**: Use username and password authentication
229
+
-**SSH Key**: Use SSH key pair for secure authentication
230
+
-**Both**: Try SSH key first, fallback to password if needed
231
+
232
+
**Server Color Coding:**
233
+
Assign colors to servers for visual distinction throughout the application. This helps identify which server you're working with when managing scripts. This needs to be enabled in the General Settings.
234
+
235
+
### General Settings
236
+
237
+
Configure application preferences and behavior.
238
+
239
+
**Save Filters:**
240
+
When enabled, your script filter preferences (search terms, categories, sorting) will be automatically saved and restored when you return to the application:
241
+
- Search queries are preserved
242
+
- Selected script types are remembered
243
+
- Sort preferences are maintained
244
+
- Category selections are saved
245
+
246
+
**Server Color Coding:**
247
+
Enable visual color coding for servers throughout the application. This makes it easier to identify which server you're working with.
248
+
249
+
**GitHub Integration:**
250
+
Add a GitHub Personal Access Token to increase API rate limits and improve performance:
251
+
- Bypasses GitHub's rate limiting for unauthenticated requests
252
+
- Improves script loading and syncing performance
253
+
- Token is stored securely and only used for API calls
254
+
255
+
**Authentication:**
256
+
Secure your application with username and password authentication:
257
+
- Set up username and password for app access
258
+
- Enable/disable authentication as needed
259
+
- Credentials are stored securely
260
+
261
+
### Sync Button
262
+
263
+
Synchronize script metadata from the ProxmoxVE GitHub repository.
264
+
265
+
**What Does Syncing Do?**
266
+
-**Updates Script Metadata**: Downloads the latest script information (JSON files)
267
+
-**Refreshes Available Scripts**: Updates the list of scripts you can download
268
+
-**Updates Categories**: Refreshes script categories and organization
269
+
-**Checks for Updates**: Identifies which downloaded scripts have newer versions
270
+
271
+
**Important Notes:**
272
+
-**Metadata Only**: Syncing only updates script information, not the actual script files
273
+
-**No Downloads**: Script files are downloaded separately when you choose to install them
274
+
-**Last Sync Time**: Shows when the last successful sync occurred
275
+
-**Rate Limits**: GitHub API limits may apply without a personal access token
276
+
277
+
**When to Sync:**
278
+
- When you want to see the latest available scripts
279
+
- To check for updates to your downloaded scripts
280
+
- If you notice scripts are missing or outdated
281
+
- After the ProxmoxVE repository has been updated
282
+
283
+
### Available Scripts
284
+
285
+
Browse and discover scripts from the ProxmoxVE repository.
286
+
287
+
**Browsing Scripts:**
288
+
-**Category Sidebar**: Filter scripts by category (Storage, Network, Security, etc.)
289
+
-**Search**: Find scripts by name or description
290
+
-**View Modes**: Switch between card and list view
291
+
-**Sorting**: Sort by name or creation date
292
+
293
+
**Filtering Options:**
294
+
-**Script Types**: Filter by CT (Container) or other script types
295
+
-**Update Status**: Show only scripts with available updates
296
+
-**Search Query**: Search within script names and descriptions
297
+
-**Categories**: Filter by specific script categories
298
+
299
+
**Script Actions:**
300
+
-**View Details**: Click on a script to see full information and documentation
301
+
-**Download**: Download script files to your local system
302
+
-**Install**: Run scripts directly on your PVE servers
303
+
-**Preview**: View script content before downloading
304
+
305
+
### Downloaded Scripts
306
+
307
+
Manage scripts that have been downloaded to your local system.
308
+
309
+
**What Are Downloaded Scripts?**
310
+
These are scripts that you've downloaded from the repository and are stored locally on your system:
311
+
- Script files are stored in your local scripts directory
312
+
- You can run these scripts on your PVE servers
313
+
- Scripts can be updated when newer versions are available
314
+
315
+
**Update Detection:**
316
+
The system automatically checks if newer versions of your downloaded scripts are available:
317
+
- Scripts with updates available are marked with an update indicator
318
+
- You can filter to show only scripts with available updates
319
+
- Update detection happens when you sync with the repository
320
+
321
+
**Managing Downloaded Scripts:**
322
+
-**Update Scripts**: Download the latest version of a script
323
+
-**View Details**: See script information and documentation
324
+
-**Install/Run**: Execute scripts on your PVE servers
325
+
-**Filter & Search**: Use the same filtering options as Available Scripts
326
+
327
+
### Installed Scripts
328
+
329
+
Track and manage scripts that are installed on your PVE servers.
330
+
331
+
**Auto-Detection (Primary Feature):**
332
+
The system can automatically detect LXC containers that have community-script tags on your PVE servers:
333
+
-**Automatic Discovery**: Scans your PVE servers for containers with community-script tags
0 commit comments