s54b/ProxmoxVE_Scripts
1
0
Fork 0
mirror of https://github.com/community-scripts/ProxmoxVE.git synced 2025-05-15 16:20:25 +00:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

Created Config File (markdown)

Michel Roegl-Brunner 2025-05-09 12:57:42 +02:00
parent 7d9ea5e085
commit b0d67ede17
1 changed files with 95 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
Config-File.md Normal file

@ -0,0 +1,95 @@
# 🧪 Testing the New Config Files Feature
We're looking for testers to try out our new **config files** feature! If you're interested in getting early access and helping us improve it, we'd love your feedback.
---
## 🚀 How to Test
We’ve created a **test branch** for this feature to avoid disrupting production use of the scripts.
**⚠️ Do not use this branch on productive systems.** This is only for development testing and feedback.
You can install the scripts as usual.
> ❗ **Note:** There is currently **no support for Alpine Linux**.
Please report all issues or feedback **in this thread only** — not as a new issue or discussion. Any unrelated reports will be closed.
We only offer support for issues **related to the config file feature** in this context.
---
### 🖥️ Run LXC Install Script
Use our scripts from the **development repo**.
After starting the script, select:
**`4 Use Config File`**
![Script Menu](https://github.com/user-attachments/assets/5d5e50ef-e7b7-477d-afea-d97a9ed56912)
---
### ⚙️ Config File Setup
Create a config file on your **PVE Host** *before running the scripts*.
Default path: /opt/community-scripts/.settings
You may change this path during the script prompt.
![Config File Path](https://github.com/user-attachments/assets/cee64943-caf1-459f-aff8-331c09c1b105)
If any values are missing in your config file, the script will fall back to default settings.
![Defaults](https://github.com/user-attachments/assets/c1a46ab4-73a9-4c02-b371-cf1a07de8fda)
---
## 🔧 Available Settings
> [!CAUTION]
> Input validation is limited. Incorrect values may break the script.
| Name | Value |
|------|-------|
| `CT_ID` | LXC ID (single number or range e.g. `100-9999`) |
| `var_os` | `debian` or `ubuntu` |
| `var_version` | Debian: `11`, `12`<br>Ubuntu: `20.04`, `22.04`, `24.04`, `24.10` |
| `CT_TYPE` | `1` = unprivileged, `0` = privileged |
| `PW` | Root password |
| `HN` | Container hostname |
| `DISK_SIZE` | Disk size in GB |
| `CORE_COUNT` | Number of CPU cores |
| `RAM_SIZE` | RAM size in MiB |
| `BRG` | Bridge name (e.g., `vmbr0`) |
| `NET` | IP address/CIDR (e.g., `192.168.0.1/24`) |
| `GATE` | Gateway IP (e.g., `192.168.0.254`) |
| `APT_CACHER_IP` | APT-cacher IP (e.g., `192.168.0.2`) |
| `DISABLEIP6` | `yes` or `no` |
| `MTU` | Network MTU (e.g., `1500`) |
| `SD` | Search domain (e.g., `example.com`) |
| `NS` | DNS server IP (e.g., `192.168.0.100`) |
| `MAC` | MAC address |
| `VLAN` | VLAN ID (e.g., `100`) |
| `TAGS` | Custom tags (semicolon-separated) |
| `SSH` | `yes` or `no` |
| `SSH_AUTHORIZED_KEY` | Public SSH key |
| `VERB` | Verbose mode: `yes` or `no` |
---
## 📄 Example Config File
Each value must be wrapped in **double quotes**:
```bash
DISK_SIZE="25"
CORE_COUNT="33"
RAM_SIZE="4500"
HN="TEST"
BRG="vmbr1"
NET="10.10.10.171/24"
GATE="10.10.10.254"
VLAN="100"
SSH="yes"
TAGS="dev;testing"
SSH_AUTHORIZED_KEY="REDACTED"