mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-02-08 05:56:45 +00:00
Fix several typos
This commit is contained in:
@@ -57,7 +57,7 @@ Pangolin provides secure, application-specific ingress and routing without the l
|
|||||||
</Card>
|
</Card>
|
||||||
</CardGroup>
|
</CardGroup>
|
||||||
|
|
||||||
### Simplified Ingess Infrastructure
|
### Simplified Ingress Infrastructure
|
||||||
|
|
||||||
<CardGroup cols={2}>
|
<CardGroup cols={2}>
|
||||||
<Card title="No Public IPs" icon="network-wired">
|
<Card title="No Public IPs" icon="network-wired">
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ In the Community Edition, identity providers are managed at the server level and
|
|||||||
|
|
||||||
After you create an IdP, on the edit page, you can manage organization policies via the "Organization Policies" tab. You can set default (fallback) policies, or define them on a per org basis.
|
After you create an IdP, on the edit page, you can manage organization policies via the "Organization Policies" tab. You can set default (fallback) policies, or define them on a per org basis.
|
||||||
|
|
||||||
### How Organization Policies Are Evalutated
|
### How Organization Policies Are Evaluated
|
||||||
|
|
||||||
It is helpful to think of the auto provisioning process as follows:
|
It is helpful to think of the auto provisioning process as follows:
|
||||||
|
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ We will revisit the **Authorised redirect URIs** field later, as we do not have
|
|||||||
|
|
||||||
## Creating an Azure Entra ID IdP in Pangolin
|
## Creating an Azure Entra ID IdP in Pangolin
|
||||||
|
|
||||||
In Pangolin, go to "Identity Providers" and click "Add Indentity Provider". Select the Azure Entra ID provider option.
|
In Pangolin, go to "Identity Providers" and click "Add Identity Provider". Select the Azure Entra ID provider option.
|
||||||
|
|
||||||
<Frame>
|
<Frame>
|
||||||
<img src="/images/create-azure-idp.png" />
|
<img src="/images/create-azure-idp.png" />
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ After hitting "Create", you will be able to see the "Client ID" and "Client secr
|
|||||||
|
|
||||||
## Creating a Google IdP in Pangolin
|
## Creating a Google IdP in Pangolin
|
||||||
|
|
||||||
In Pangolin, go to "Identity Providers" and click "Add Indentity Provider". Select the Google provider option.
|
In Pangolin, go to "Identity Providers" and click "Add Identity Provider". Select the Google provider option.
|
||||||
|
|
||||||
<Frame>
|
<Frame>
|
||||||
<img src="/images/create-google-idp.png" />
|
<img src="/images/create-google-idp.png" />
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ This identity provider follows the OpenID Connect protocol. This means that it c
|
|||||||
|
|
||||||
## Creating a Generic OAuth2/OIDC IdP in Pangolin
|
## Creating a Generic OAuth2/OIDC IdP in Pangolin
|
||||||
|
|
||||||
In Pangolin, go to "Identity Providers" and click "Add Indentity Provider". Select the OAuth2/OIDC provider option.
|
In Pangolin, go to "Identity Providers" and click "Add Identity Provider". Select the OAuth2/OIDC provider option.
|
||||||
|
|
||||||
<Frame>
|
<Frame>
|
||||||
<img src="/images/create-oidc-idp.png" />
|
<img src="/images/create-oidc-idp.png" />
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ After you have created the OIDC Client, take note of the following fields from t
|
|||||||
|
|
||||||
## Configuring Identity Providers in Pangolin
|
## Configuring Identity Providers in Pangolin
|
||||||
|
|
||||||
In Pangolin, go to “Identity Providers” and click “Add Indentity Provider”. Select the OAuth2/OIDC provider option.
|
In Pangolin, go to “Identity Providers” and click “Add Identity Provider”. Select the OAuth2/OIDC provider option.
|
||||||
|
|
||||||
"Name" should be set to something memorable (eg. Pocket ID). The "Provider Type" should be set to the default `OAuth2/OIDC`.
|
"Name" should be set to something memorable (eg. Pocket ID). The "Provider Type" should be set to the default `OAuth2/OIDC`.
|
||||||
|
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ When you click create, you'll be shown the `ClientSecret` and `ClientId`. Make s
|
|||||||
|
|
||||||
## Configuring Identity Providers in Pangolin
|
## Configuring Identity Providers in Pangolin
|
||||||
|
|
||||||
In Pangolin, go to “Identity Providers” and click “Add Indentity Provider”. Select the OAuth2/OIDC provider option.
|
In Pangolin, go to “Identity Providers” and click “Add Identity Provider”. Select the OAuth2/OIDC provider option.
|
||||||
|
|
||||||
"Name" should be set to something memorable (eg. Zitadel). The "Provider Type" should be set to the default `OAuth2/OIDC`.
|
"Name" should be set to something memorable (eg. Zitadel). The "Provider Type" should be set to the default `OAuth2/OIDC`.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ description: "Update Newt to the latest version"
|
|||||||
|
|
||||||
The update process depends on how you originally installed Newt.
|
The update process depends on how you originally installed Newt.
|
||||||
|
|
||||||
Find the lates version in the [GitHub releases](https://github.com/fosrl/newt/releases).
|
Find the latest version in the [GitHub releases](https://github.com/fosrl/newt/releases).
|
||||||
|
|
||||||
## Docker Installation
|
## Docker Installation
|
||||||
|
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ homeassistant:
|
|||||||
- "https://<subdomain>.example.com" # <-- Replace with URL of created resource in Pangolin
|
- "https://<subdomain>.example.com" # <-- Replace with URL of created resource in Pangolin
|
||||||
```
|
```
|
||||||
|
|
||||||
4.5: If you wan't to use SSO Authentication in Pangolin you need to set up the `configuration.yaml` like this:
|
4.5: If you want to use SSO Authentication in Pangolin you need to set up the `configuration.yaml` like this:
|
||||||
```
|
```
|
||||||
http:
|
http:
|
||||||
cors_allowed_origins:
|
cors_allowed_origins:
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ This setup will increase the use of your server RAM.
|
|||||||
|
|
||||||
For claiming metrics from Traefik we have to adjust some configuration files.
|
For claiming metrics from Traefik we have to adjust some configuration files.
|
||||||
|
|
||||||
1. Udpate the `docker-compose.yml` file of the Pangolin stack to expose metrics port `8082` for the Prometheus connection:
|
1. Update the `docker-compose.yml` file of the Pangolin stack to expose metrics port `8082` for the Prometheus connection:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
service:
|
service:
|
||||||
@@ -63,7 +63,7 @@ sudo docker restart traefik gerbil
|
|||||||
|
|
||||||
For claiming metrics from Crowdsec we have to adjust the docker compose files.
|
For claiming metrics from Crowdsec we have to adjust the docker compose files.
|
||||||
|
|
||||||
1. Udpate the `docker-compose.yml` file of the Pangolin stack to expose metrics port `6060` for the Prometheus connection:
|
1. Update the `docker-compose.yml` file of the Pangolin stack to expose metrics port `6060` for the Prometheus connection:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
service:
|
service:
|
||||||
@@ -130,7 +130,7 @@ scrape_configs:
|
|||||||
- targets: ["172.17.0.1:6060"]
|
- targets: ["172.17.0.1:6060"]
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Create a folder `data` in `/config/prometheus` and change the ower and owning group:
|
3. Create a folder `data` in `/config/prometheus` and change the owner and owning group:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
chown nobody:nogroup data
|
chown nobody:nogroup data
|
||||||
@@ -139,7 +139,7 @@ chown nobody:nogroup data
|
|||||||
4. Start the Prometheus container:
|
4. Start the Prometheus container:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo docker conpose up -d
|
sudo docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
## Grafana
|
## Grafana
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ For more details, please refer to the following resources:
|
|||||||
|
|
||||||
## Metrics
|
## Metrics
|
||||||
|
|
||||||
Currently you can claim metric data from Traefik and Crowdsec with Prometheus and visiulize it within a Grafana Dashboard.
|
Currently you can claim metric data from Traefik and Crowdsec with Prometheus and visualize it within a Grafana Dashboard.
|
||||||
|
|
||||||
### Prometheus
|
### Prometheus
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: "Proxy Protocol"
|
|||||||
description: "Using Proxy Protocol to Preserve Client IPs for TCP/UDP backends"
|
description: "Using Proxy Protocol to Preserve Client IPs for TCP/UDP backends"
|
||||||
---
|
---
|
||||||
|
|
||||||
Did you ever want to get the real ip instead of newt's IP or traefik's IP for TCP/UDP applications? Then follow below, Just be warned this is not a begineer guide.
|
Did you ever want to get the real ip instead of newt's IP or traefik's IP for TCP/UDP applications? Then follow below, Just be warned this is not a beginner guide.
|
||||||
|
|
||||||
This guide shows how to enable Proxy Protocol manually until a GUI option becomes available.
|
This guide shows how to enable Proxy Protocol manually until a GUI option becomes available.
|
||||||
|
|
||||||
|
|||||||
@@ -66,7 +66,7 @@ The Enterprise Edition is distributed under the **Fossorial Commercial License**
|
|||||||
Complete the license application form.
|
Complete the license application form.
|
||||||
|
|
||||||
<Tip>
|
<Tip>
|
||||||
Innacurate representation is a violation of the license and will result in the license being revoked.
|
Inaccurate representation is a violation of the license and will result in the license being revoked.
|
||||||
</Tip>
|
</Tip>
|
||||||
</Step>
|
</Step>
|
||||||
|
|
||||||
@@ -121,7 +121,7 @@ The Enterprise Edition is distributed under the **Fossorial Commercial License**
|
|||||||
```
|
```
|
||||||
|
|
||||||
<Warning>
|
<Warning>
|
||||||
The Enterprise Edition image is stagged with `ee` (e.g., `fosrl/pangolin:ee-latest`) and is different from the Community Edition (`fosrl/pangolin:latest`). Make sure to use the correct image.
|
The Enterprise Edition image is tagged with `ee` (e.g., `fosrl/pangolin:ee-latest`) and is different from the Community Edition (`fosrl/pangolin:latest`). Make sure to use the correct image.
|
||||||
</Warning>
|
</Warning>
|
||||||
</Step>
|
</Step>
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user