flynx/proxmox-utils
1
0
Fork 0
mirror of https://github.com/flynx/proxmox-utils.git synced 2025-10-28 18:50:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2024-10-22 13:37:06 +03:00
parent e404ea7d77
commit 456078c1f5
1 changed files with 27 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -100,7 +100,7 @@ The ADMIN network is connected to the admin port.
Both networks are provided DNS and DHCP services by the `ns` CT. Both networks are provided DNS and DHCP services by the `ns` CT.
Services on both networks are connected to the outside world (WAN) via Services on either network are connected to the outside world (WAN) via
a NAT router implemented by the `gate` CT (`iptables`). a NAT router implemented by the `gate` CT (`iptables`).
The `gate` CT also implements a reverse proxy ([`traefik`](https://traefik.io/traefik/)), The `gate` CT also implements a reverse proxy ([`traefik`](https://traefik.io/traefik/)),
@ -116,7 +116,7 @@ The `gate` and `ns` CT's are only accessible for administration from the
host (i.e. via `lxc-attach ..`). host (i.e. via `lxc-attach ..`).
Three ways of access to the ADMIN network are provided: Three ways of access to the ADMIN network are provided:
- `wireguard` VPN (CT) via `gate` reverse proxy, - [`wireguard`](https://www.wireguard.com/) VPN (CT) via `gate` reverse proxy,
- `ssh` service (CT) via the `gate` reverse proxy, - `ssh` service (CT) via the `gate` reverse proxy,
- `ssh` service (CT) via the direct `$WAN_SSH_IP` (fail-safe). - `ssh` service (CT) via the direct `$WAN_SSH_IP` (fail-safe).
@ -164,7 +164,9 @@ _It is recommended to review the script/code before starting._
This will: This will:
- Install basic dependencies, - Install basic dependencies,
- Clone this repo, - Clone this repo,
- Run `make bootstrap` on the repo. - Run `make bootstrap` on the repo:
- bootstrap configure the network (2 out of 3 stages)
- build and infrastructure start CT's (`gate`, `ns`, `ssh`, and `wireguard`)
At this point WAN interface exposes two IPs: At this point WAN interface exposes two IPs:
- Main server (config: `$DFL_WAN_IP` / `$WAN_IP`) - Main server (config: `$DFL_WAN_IP` / `$WAN_IP`)
@ -173,8 +175,11 @@ At this point WAN interface exposes two IPs:
- Fail-safe ssh (config: `$DFL_WAN_SSH_IP` / `$WAN_SSH_IP`) - Fail-safe ssh (config: `$DFL_WAN_SSH_IP` / `$WAN_SSH_IP`)
- ssh:22 - ssh:22
The Proxmox administrative interface is available behind the Wireguard The Proxmox administrative interface is available behind the
proxy or on the ADMIN port, both on https://10.0.0.254:8006. [Wireguard](https://www.wireguard.com/) proxy or on the ADMIN port, both
on https://10.0.0.254:8006.
Additional administrative tasks can be performed now if needed.
To finalize the setup run: To finalize the setup run:
```shell ```shell
@ -248,16 +253,25 @@ bridges or interfaces defined.
## Services ## Services
XXX Install all user services:
```shell ```shell
make all make all
``` ```
Includes:
- [`syncthing`](#syncthing)
- [`nextcloud`](#nextcloud)
Install development services:
```shell ```shell
make dev make dev
``` ```
Includes:
- [`gitea`](#gitea)
### Syncthing ### Syncthing
@ -267,6 +281,8 @@ make syncthing
XXX XXX
For more info see: https://syncthing.net/
### Nextcloud ### Nextcloud
@ -276,6 +292,8 @@ make nextcloud
XXX XXX
For more info see: https://nextcloud.com/
### Gitea ### Gitea
@ -286,6 +304,8 @@ make gitea
XXX XXX
For more info see: https://about.gitea.com/
### Custom services ### Custom services