start unraid docs

packages/docusaurus/docs/02-Getting Started/02-Manual Install Guides/01-docker-compose.md

@@ -1,4 +1,4 @@
-# Manual Install
+# Docker Compose
 
 :::warning
 

packages/docusaurus/docs/02-Getting Started/02-Manual Install Guides/02-unraid.md

@@ -0,0 +1,124 @@
+# Unraid
+
+:::warning
+
+Installing Pangolin, Gerbil, and Traefik on Unraid assumes you are able to port forward on the network running these servers. If you're behind CGNAT, install Pangolin a VPS and install Newt on your Unraid server to bypass the port forwarding restriction.
+
+**If you just want to install Newt on Unraid, and have no interest in running Pangolin and its components, there is a Newt container available in the Community Apps store.**
+
+:::
+
+:::note
+
+You can use an existing Traefik installation should you have one, but it will require more manual/custom configuration. This guide will focus on setting up Traefik from scratch to work with our system, but you're free to modify the Traefik configuration as much as you'd like.
+
+If you're installing from scratch, we provide a custom Traefik template with some defaults already set. Our template still uses the official Traefik images. However, you're able to use any Traefik template you would like, such as the popular one by IBRACORP.
+
+:::
+
+The first part of this tutorial will explain how to use Pangolin and Traefik as a local reverse proxy without Gerbil and its tunneling features. The second (optional) part will expand on this and show how to enable tunneling by setting up Gerbil.
+
+All containers are available in the Unraid Community Apps (CA) store. If you're not familiar with Unraid, you can find more information on their [website](https://unraid.net/).
+
+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.
+
+## 1. Setup Pangolin and Traefik
+
+This first part will enable Pangolin to work in "Local" reverse proxy mode. Newt and WireGuard will **not** be able to be used after finishing this first part. However, if you want to use those features, you still need to follow this first part of the tutorial because we show how to setup Pangolin and Traefik first.
+
+### Install and Setup Pangolin
+
+#### 1. Go to the CA store and search for `Pangolin`, and click on the `Install` button. This will take you to the configuration page.
+
+#### 2. Configure the variables:
+
+<p align="center">
+    ![graphic](./img/pangolin_config.png)
+</p>
+
+Some important considerations:
+
+Server Admin Email:
+
+The server admin email is maily used to setup the first "Server Admin" account which you will use to log in for the first time. If you allow Pangolin to generate the Traefik config for you, this will also be used as the Let's Encrypt admin email for certs. If you wish to use a different email for Let's Encrypt, you would need to manually edit the Traefik config file after it's been created. For the vast majority of people, it is perfectly fine to use the same email for both.
+
+Generate Traefik Config:
+
+This is primarily here for your convience. Setting this to `true` will have Pangolin generate the Traefik files for you and insert the needed info based on the other Pangolin config settings. Traefik files will be placed in `<appdata>/config/traefik`. On each container restart, these files will be overwritten by Pangolin. Thus, if you edit the Traefik files manually, you should set this to `false`. It's best to keep this enabled on first start to generate the files for you to edit later.
+
+If you're using a different Traefik config other than the one provided by Pangolin, it is okay to leave this enabled. It will not overwrite your config unless your config is in the `<appdata>/config/traefik` path which it unlikely is.
+
+Ports:
+
+Due to the way Pangolin was designed to work with docker compose and a config file, the way it handles ports is a little different as compared to other popular Unraid containers.
+
+For all host ports:
+
+The host ports, container ports, and ports in the config should match for simplicity. This is because the Pangolin config also has ports in it. If you decide to use a non-default port, you would need to add the matching environment variable or edit the `config.yml` file to match. For example:
+
+If I wanted to change Host Port 1, I would do the following:
+
+- Click edit on the port
+- Set the "Container Port" to the new port you want to use
+- Set the "Host Port" to the new port you want to use
+- Add a new environment variable with with key `SERVER_NEXTPORT` and value as the new port you want to use
+
+This does not apply to the WireGuard port.
+
+Any Gerbil Config:
+
+You can leave these here even if you don't plan to use Gerbil.
+
+Gerbil Base Endpoint:
+
+This should match the Dashboard Url field.
+
+3. Save the config and start the Pangolin container.
+
+Upon starting, Pangolin will create the needed files in the appdata path. You can access the dashboard WebUI by the "Host Port 1" port on your Unraid machine.
+
+#### 4. Log in to the dashboard
+
+Log in with the admin email and password you set in the config. Follow the setup steps.
+
+- Create your first Organization
+- Create your first "Local" site for local reverse proxying
+
+### Install and Setup Traefik
+
+1. Install Traefik
+
+This section will use the Traefik template from the "Fossorial" repository. It still uses the official Traefik container image. If you already have a Traefik installation running, you should manually configure your Traefik config to work with Pangolin. Take a look at the Traefik files in the Docker Compose guide to see what to add to your config. Also, if you'd prefer to use another Traefik template in the Unraid store such as IBRACORP's you still can. You should just make sure to have the needed variables, ports, paths, etc, as described in this guide.
+
+<p align="center">
+    <img src={require("./img/traefik_repo.png").default} alt="Traefik Repo" style={{
+        width: "400px",
+        height: "auto"
+    }}/>
+</p>
+
+2. Configure Traefik
+
+<p align="center">
+    ![graphic](./img/traefik_config.png)
+</p>
+
+Please refer to the official Traefik docs for more information on the Traefik configuration beyond this guide.
+
+The only important considerations here:
+
+Config Folder:
+
+If you're using the Traefik config generated by Pangolin, point this to the `<appdata>/config/traefik` path.
+
+Lets Encrypt Certs:
+
+Traefik will store the certification information here. You can make this path anywhere you want. For simplicity, we're placing it in the same config path at `<appdata>/config/letsencrypt`.
+
+Ports:
+
+You will need to port forward the https and http ports listed in the config on your network's router.
+
+## 2. Add Gerbil for Tunneling (Optional)
+
+### Install and Setup Gerbil

packages/docusaurus/docs/03-Pangolin/02-Configuration/02-config.md

@@ -147,7 +147,7 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
 -   `require_email_verification`: boolean
     -   Whether to require email verification for new users. If set to `true`, new users will need to verify their email address before they can log in.
     -   Only turn this on if you have email configured.
--   `signup_without_invite`: boolean
+-   `disable_signup_without_invite`: boolean
     -   Whether to allow users to sign up without an invite. If set to `false`, the "Sign Up" button will be removed from the login form.
     -   Users will still be able to sign up if they have a valid invite.
 -   `disable_user_create_org`: boolean