fosrl/docs
1
0
Fork 0
mirror of https://github.com/fosrl/docs.git synced 2025-05-13 05:40:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'main' into dev

Browse source
This commit is contained in:
miloschwartz 2025-03-22 12:39:19 -04:00
commit 2b357dbe81
No known key found for this signature in database
4 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/docusaurus/docs/02-Getting Started/03-quick-install.md
View file

@ -47,7 +47,7 @@ sudo ./installer
The installer will prompt you for the following basic information. For example: The installer will prompt you for the following basic information. For example:
1. **Base Domain Name**: Enter your base fully qualified domain name (without any subdomains) Example: `example.com` 1. **Base Domain Name**: Enter your base fully qualified domain name (without any subdomains) Example: `example.com`
2. **Dashboard Domain Name**: The domain where the application will be hosted. This is used for many things, including generating links. You can run Pangolin on a subdomain or root domain. Example: `proxy.example.com` 2. **Dashboard Domain Name**: The domain where the application will be hosted. This is used for many things, including generating links. You can run Pangolin on a subdomain or root domain. Example: `pangolin.example.com`
3. **Let's Encrypt Email**: Provide an email address for SSL certificate registration with Lets Encrypt. This should be an email you have access to. 3. **Let's Encrypt Email**: Provide an email address for SSL certificate registration with Lets Encrypt. This should be an email you have access to.
4. **Tunneling** You can choose not to install Gerbil for tunneling support - in this config it will just be a normal reverse proxy. See [how to use without tunneling](/03-Pangolin/03-without-tunneling.md). 4. **Tunneling** You can choose not to install Gerbil for tunneling support - in this config it will just be a normal reverse proxy. See [how to use without tunneling](/03-Pangolin/03-without-tunneling.md).

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

@ -7,7 +7,7 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
### `app` ### `app`
- `dashboard_url`: string - `dashboard_url`: string
- Example: `https://example.com` or `https://proxy.example.com` - Example: `https://example.com` or `https://pangolin.example.com`
- The url where the application is hosted. This is used for many things, including generating links. - The url where the application is hosted. This is used for many things, including generating links.
- You can run Pangolin on a subdomain or root domain. Users will be redirected to this url to complete the auth step. - You can run Pangolin on a subdomain or root domain. Users will be redirected to this url to complete the auth step.
- `log_level`: string - `log_level`: string
@ -45,7 +45,7 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
- `cors`: object (optional) - `cors`: object (optional)
- Configuration for Cross-Origin Resource Sharing (CORS). - Configuration for Cross-Origin Resource Sharing (CORS).
- `origins`: array of strings (optional) - `origins`: array of strings (optional)
- Example: `["https://proxy.example.com"]` - Example: `["https://pangolin.example.com"]`
- List of allowed origins for cross-origin requests. - List of allowed origins for cross-origin requests.
- `methods`: array of strings (optional) - `methods`: array of strings (optional)
- Example: `["GET", "POST", "PUT", "DELETE", "PATCH"]` - Example: `["GET", "POST", "PUT", "DELETE", "PATCH"]`

2
packages/docusaurus/docs/03-Pangolin/04-api-documentation.md
View file

@ -7,8 +7,6 @@ Initial API documentation for pangolin. This documentation includes public endpo
https://pangolin.yourdomain.com/api/v1/ https://pangolin.yourdomain.com/api/v1/
``` ```
I'll create an improved API documentation based on the files provided. Here's the updated markdown:
## 1. Public Endpoints ## 1. Public Endpoints
### 1.1 User Management ### 1.1 User Management

2
packages/docusaurus/src/components/DynamicTraefikConfig.tsx
View file

@ -39,7 +39,7 @@ const DynamicTraefikConfig: React.FC = () => {
# WebSocket router # WebSocket router
ws-router: ws-router:
rule: "Host(\`proxy.example.com\`)" # REPLACE THIS WITH YOUR DOMAIN rule: "Host(\`pangolin.example.com\`)" # REPLACE THIS WITH YOUR DOMAIN
service: api-service service: api-service
entryPoints: entryPoints:
- websecure - websecure