add unraid section to newt install

This commit is contained in:
Milo Schwartz 2025-01-19 17:32:27 -05:00
parent 121cf70dac
commit 4bd91e3dc0
No known key found for this signature in database
5 changed files with 27 additions and 6 deletions

View file

@ -4,12 +4,12 @@
- A Linux system with root access and a public IP address
- We recommend Ubuntu or Debian based systems
- [A domain name pointed to your server's IP address](./04-dns-networking.md)
- [TCP ports 80, 443, and UDP port 51820 exposed to your Linux instance.](./04-dns-networking.md)
- [A domain name pointed to your server's IP address](./02-dns-networking.md)
- [TCP ports 80, 443, and UDP port 51820 exposed to your Linux instance.](./02-dns-networking.md)
- An email address for Let's Encrypt certificate registration
- (Optionally) a SMTP server
Note: If you have **Cloudflare** as your DNS provider [turn off the proxy service](./04-dns-networking.md).
Note: If you have **Cloudflare** as your DNS provider [turn off the proxy service](./02-dns-networking.md).
## Installation Steps

View file

@ -12,8 +12,8 @@ This guide will walk you through setting up the Docker Compose stack manually wi
- A Linux system with root access and a public IP address
- We recommend Ubuntu or Debian based systems
- [A domain name pointed to your server's IP address](./04-dns-networking.md)
- [TCP ports 80, 443, and UDP port 51820 exposed to your Linux instance.](./04-dns-networking.md)
- [A domain name pointed to your server's IP address](../02-dns-networking.md)
- [TCP ports 80, 443, and UDP port 51820 exposed to your Linux instance.](../02-dns-networking.md)
- An email address for Let's Encrypt certificate registration
- (Optionally) a SMTP server

View file

@ -22,6 +22,10 @@ All containers are available in the Unraid Community Apps (CA) store. If you're
This installation has a lot of moving parts and is a bit non-standard for Unraid because Pangolin and its components were designed to run as micro-services on a VPS in tunneling mode. However, some may want to use "Local" reverse proxying on their Unraid server or use their Unraid server as a tunnel controller with Gerbil. For either of these use cases, follow the steps outlined in this guide.
## Video Tutorial
If you prefer a video tutorial for this guide, you can find it [here](https://youtu.be/F3w1Ur175zI).
## Prerequisites
- A working Unraid server.
@ -55,6 +59,12 @@ This first part will enable Pangolin to work in "Local" reverse proxy mode. Newt
Set the network to the one you created earlier.
:::note
Pangolin environment variables will take precedence over the values in the `config.yml` file. If you set an environment variable, it will override the value in the `config.yml` file. This is useful for setting secrets and other sensitive information.
:::
<p align="center">
![graphic](./img/pangolin_config.png)
</p>

View file

@ -83,7 +83,18 @@ services:
- --endpoint https://example.com
```
#### Unraid, Portainer, and other UIs
### Unraid
Newt is available in the Unraid Community Applications store. You can install it by searching for Newt in the store and following the prompts. Enter in the ID, secret, and endpoint from Pangolin in the template fields.
<p align="center">
<img src={require("./img/unraid_store.png").default} alt="Newt on CA" style={{
width: "400px",
height: "auto"
}}/>
</p>
### Portainer, and other UIs
These container management UIs typically allow for passing commands and environment vars to the container similar to Docker compose. Look for a commands or arguments box and follow relevant guides.

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB