mirror of
https://github.com/fosrl/docs.git
synced 2025-05-13 13:50:38 +01:00
Merge branch 'main' of https://github.com/fosrl/docs
This commit is contained in:
Owen Schwartz
commit
e8b78363a6
3 changed files with 10 additions and 63 deletions
|
|
@ -221,58 +221,7 @@ http:
|
|||
|
||||
`config/config.yml`
|
||||
|
||||
See the [Configuration](https://docs.fossorial.io/Pangolin/Configuration/config) section for more details.
|
||||
|
||||
```yaml
|
||||
app:
|
||||
base_url: https://proxy.example.com
|
||||
log_level: info
|
||||
save_logs: false
|
||||
|
||||
server:
|
||||
external_port: 3000
|
||||
internal_port: 3001
|
||||
next_port: 3002
|
||||
internal_hostname: pangolin
|
||||
secure_cookies: true
|
||||
session_cookie_name: p_session
|
||||
resource_session_cookie_name: p_resource_session
|
||||
|
||||
traefik:
|
||||
cert_resolver: letsencrypt
|
||||
http_entrypoint: web
|
||||
https_entrypoint: websecure
|
||||
prefer_wildcard_cert: true
|
||||
|
||||
gerbil:
|
||||
start_port: 51820
|
||||
base_endpoint: proxy.example.com
|
||||
use_subdomain: false
|
||||
subnet_group: 10.0.0.0/8
|
||||
block_size: 16
|
||||
|
||||
rate_limits:
|
||||
global:
|
||||
window_minutes: 1
|
||||
max_requests: 100
|
||||
|
||||
email:
|
||||
smtp_host: host.hoster.net
|
||||
smtp_port: 587
|
||||
smtp_user: no-reply@example.com
|
||||
smtp_pass: aaaaaaaaaaaaaaaaaa
|
||||
no_reply: no-reply@example.com
|
||||
|
||||
users:
|
||||
server_admin:
|
||||
email: admin@example.com
|
||||
password: Password123!
|
||||
|
||||
flags:
|
||||
require_email_verification: true
|
||||
disable_signup_without_invite: true
|
||||
disable_user_create_org: true
|
||||
```
|
||||
See the [Configuration](https://docs.fossorial.io/Pangolin/Configuration/config) section for more details and examples.
|
||||
|
||||
## Starting the Stack
|
||||
|
||||
|
|
|
|||
|
|
@ -6,10 +6,13 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
|
|||
|
||||
### app
|
||||
|
||||
- `base_url`: string
|
||||
- `dashboard_url`: string
|
||||
- Example: `https://example.com` or `https://proxy.example.com`
|
||||
- The url where the application is hosted. This is used for many things, including generating links, and determing the root domain for cookies, etc.
|
||||
- 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.
|
||||
- `base_domain`: string
|
||||
- Example: `example.com`
|
||||
- The base domain for the application. This is used for setting cookies and determining the base domain for resources.
|
||||
- `log_level`: string
|
||||
- Options: `debug`, `info`, `warn`, `error`
|
||||
- The log level for the application.
|
||||
|
|
@ -36,11 +39,9 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
|
|||
- `session_cookie_name`: string
|
||||
- Example: `p_session`
|
||||
- The name of the session cookie. This is used to store the session token for the main application.
|
||||
- Cookies will be set for the base domain of the `base_url` config.
|
||||
- `resource_session_cookie_name`: string
|
||||
- Example: `p_resource_session`
|
||||
- The prefix for the resource specific session cookie. When a user authenticates directly with a resource, this is used to store the session token for that resource.
|
||||
- Cookies will be set for the base domain of the `base_url` config.
|
||||
|
||||
### traefik
|
||||
|
||||
|
|
@ -128,7 +129,8 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
|
|||
|
||||
```yaml
|
||||
app:
|
||||
base_url: https://example.com
|
||||
dashboard_url: https://example.com
|
||||
base_domain: example.com
|
||||
log_level: info
|
||||
save_logs: false
|
||||
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ npm install
|
|||
|
||||
2. Ensure you have a config file
|
||||
|
||||
Make sure you have a `config/` directory at the root with a `config.yml` inside. Refer to the Pangolin Configuration docs or the `config.example.yml` in the repo for sample of what to include in that file. You may need to tweak this to run in dev, such as setting the `base_url` to `http://localhost` and making sure `secure_cookies` is `false`.
|
||||
Make sure you have a `config/` directory at the root with a `config.yml` inside. Refer to the Pangolin Configuration docs or the `config.example.yml` in the repo for sample of what to include in that file. You may need to tweak this to run in dev, such as setting the `dashboard_url` to `http://localhost` and `base_domain` to `localhost` and making sure `secure_cookies` is `false`.
|
||||
|
||||
3. Generate the database schema and push it
|
||||
|
||||
|
|
@ -84,7 +84,7 @@ npm run dev
|
|||
|
||||
When running Pangolin for the first time there will be no exit nodes. This means that there have been no Gerbil "exit nodes" registered in the database. When Gerbil first starts up and requests its config from Pangolin for the first time it gets registered as an exit node.
|
||||
|
||||
The easiest way to resovle this is to run Gerbil and have it register in your dev enviroment. Download the Gerbil binary and run it with localhost:
|
||||
The easiest way to resolve this is to run Gerbil and have it register in your dev environment. Download the Gerbil binary and run it with localhost:
|
||||
|
||||
```
|
||||
./gerbil \
|
||||
|
|
@ -111,7 +111,3 @@ make local
|
|||
```bash
|
||||
make local
|
||||
```
|
||||
|
||||
## Contributing Code
|
||||
|
||||
- If you are taking on an existing bug or feature ticket, please comment on the issues page of the repo you're working on to avoid multiple people working on the same thing.
|
||||
|
|
|
|||
Loading…
Reference in a new issue