Skip to content

Commit b4b2ec9

Browse files
Adding a community guide for running Invidious on Proxmox with VMs or LXCs (#697)
* Add Proxmox setup guide for Invidious Added a section for Proxmox VMs and LXCs with setup instructions. * Enhance community installation guide details Updated the installation guide to include details about self-signed HTTPS reverse proxy and Linux service for automatic startup. * Update community installation guide with new sections Added prerequisites and installation instructions for Invidious setup in Proxmox.
1 parent b8351dd commit b4b2ec9

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

docs/community-installation-guide.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,40 @@ And the whole application can be now started:
294294

295295
Keep in mind that generated units cannot be enabled using `systemctl --user enable`. The Invidious containers will be started automatically.
296296

297+
## Proxmox VMs and LXCs
298+
299+
Guide contributor(s): [@SimplyProgrammer](https://github.com/SimplyProgrammer)
300+
301+
This method provides a simple and straightforward guide with scripts to setup Invidious inside a Proxmox Linux VM or LXC container.
302+
It utilizes podman to create Invidious containers, Caddy 2 for self-signed https reverse proxy and Linux service for automatic startup.
303+
304+
### Prerequirements
305+
Debian 12+ VM or an unprivileged Debian 12+ LXC container with:
306+
* Name "invidious" (or something similar)
307+
* 4GB+ of RAM
308+
* 2+ x86_64 cores, 4 is ideal (ARM is also possible but `compose.yml` has to be modified accordingly).
309+
* 20+GB of storage
310+
* Static IP or static DHCP lease on your router.
311+
312+
### Networking
313+
Further, you will need a DNS domain, paid or local one to point to this IP of your LXC/VM with Invidious.
314+
It would be great if your router would allow/do this by default, and automatically assign something like `invidious.lan` or even better, `invidious.home.arpa` to your LXC/VM. For example, [OpenWrt](https://forum.openwrt.org/t/use-home-arpa-as-default-tld-for-local-network/165056/11) does this by default. For other routers, extra config might be needed.
315+
If you have your own domain, reversed-proxy etc., setup might differ for you...
316+
317+
### Installation
318+
Run this script (with sudo privileges or as root):
319+
```
320+
mkdir -p ~/invidious-podman && cd "$_" && git clone "https://github.com/SimplyProgrammer/Invidious-podman-LXC-VM.git" . && chmod 755 setup-invidious.sh && ./setup-invidious.sh
321+
```
322+
When it asks for the Invidious git repo, for 90% of you just press enter (unless you have your own forked one).
323+
324+
The most important part, when it asks for the DNS domain, specify aforementioned `invidious.lan`, `invidious.home.arpa` or whatever you have. But make sure the domain is reachable and working in advance (`nslookup` etc.).
325+
326+
If everything was done properly, now you should have a working LXC/VM with Invidious service and should be able to open it at `https://<your-invidious-domain>/`.\
327+
It should automatically start with your VM/LXC, no extra work needed.
328+
329+
More info and the whole solution is available for review at https://github.com/SimplyProgrammer/Invidious-podman-LXC-VM.
330+
297331
## MacOS
298332

299333
Looking for contributors to this operating system. Please submit a new doc for MacOS at https://github.com/iv-org/documentation/blob/master/docs/community-installation-guide.md

0 commit comments

Comments
 (0)