Add Proxmox LXC docs #35

Merged
rogs merged 3 commits from add-proxmox-lxc-docs into master 2025-03-30 09:35:14 -03:00
2 changed files with 49 additions and 3 deletions
Showing only changes of commit da86d2fdf5 - Show all commits

View File

@ -0,0 +1,44 @@
---
title: "Proxmox LXC Prerequisites"
date: 2025-03-29T10:00:00-03:00 #<-- Adjusted date
draft: false
weight: 1 #<-- Placed early in Advanced section
summary: Required steps before installing YAMS in a Proxmox LXC container.
---
# Prerequisites for Installing YAMS in a Proxmox LXC
If you plan to install YAMS inside a Proxmox LXC container, some specific host-level configuration is required **before** you run the YAMS installation script. These steps ensure Docker and the VPN component (Gluetun) can function correctly within the LXC environment by providing access to the necessary TUN device.
> **Note:** This guide is based on the solution discovered and shared by forum user **Bobs_Manager**. You can find the original discussion [here on the YAMS Forum](https://forum.yams.media/viewtopic.php?t=212).
⚠️ **Important:** Only use an **unprivileged** LXC container for YAMS. Privileged containers pose significant security risks and are not recommended.
Follow these steps on your Proxmox **host** system:
1. **Access the Proxmox Host Shell:** Log into your Proxmox server via SSH or use the web UI's shell access for the node (not the LXC console).
2. **Edit the LXC Configuration File:** Open the configuration file specific to the LXC container where you intend to install YAMS. Replace `<container-ID>` with the actual numeric ID of your LXC container.
```bash
nano /etc/pve/lxc/<container-ID>.conf
```
3. **Add Configuration Lines:** Append the following lines to the **end** of the file. These lines grant the container necessary permissions and crucially mount the `/dev/net/tun` device from the host into the container.
```ini
lxc.cgroup.devices.allow: a
lxc.cap.drop:
lxc.cgroup2.devices.allow: c 10:200 rwm
lxc.mount.entry: /dev/net/tun dev/net/tun none bind,create=file
```
4. **Save and Close:** Save the changes to the configuration file and exit the editor.
5. **Restart the LXC Container:** For the changes to take effect, you must restart the LXC container. You can do this via the Proxmox web UI or using the following commands on the Proxmox host:
```bash
pct stop <container-ID>
pct start <container-ID>
```
## Next Steps
After completing these prerequisites and restarting the LXC container, you can now log into the LXC container's console and proceed with the standard YAMS installation as described in the [Installation Guide](/install/steps/).

View File

@ -9,7 +9,7 @@ summary: First steps to install YAMS on your server
YAMS only needs a few things to get started:
- Debian 12 (recommended) or Ubuntu 24.04. If your OS isn't ready yet, check out these guides:
- Debian 12 (recommended) or Ubuntu 24.04 running on bare metal, a VM, or certain container types. If your OS isn't ready yet, check out these guides:
+ https://www.digitalocean.com/community/tutorials/initial-server-setup-with-debian-11 (this tutorial is for Debian 11, but it should be the same).
+ https://www.digitalocean.com/community/tutorials/initial-server-setup-with-ubuntu-22-04 (this tutorial is for Ubuntu 22.04, but is should be the same).
- Your OS needs to be properly configured. That means:
@ -20,9 +20,11 @@ YAMS only needs a few things to get started:
$ which docker
/snap/bin/docker
```
You **won't** be able to install YAMS. ⚠️
You **won't** be able to install YAMS. ⚠️
Don't worry if you don't have `docker` and `docker-compose` installed - the script can handle that for you on Debian and Ubuntu!
- **Proxmox LXC Users:** YAMS can be installed within an unprivileged Proxmox LXC container, but this requires specific configuration on the Proxmox host **before** you run the YAMS installation script inside the container. Please follow the steps in our [Proxmox LXC Prerequisites guide](/advanced/proxmox-lxc-prerequisites/) before proceeding with the installation steps below.
Don't worry if you don't have `docker` and `docker-compose` installed - the script can handle that for you on Debian and Ubuntu!
## Before running