diff --git a/packages/docusaurus/docs/03-Pangolin/02-Configuration/02-config.md b/packages/docusaurus/docs/03-Pangolin/02-Configuration/02-config.md index 440db21..6e558f2 100644 --- a/packages/docusaurus/docs/03-Pangolin/02-Configuration/02-config.md +++ b/packages/docusaurus/docs/03-Pangolin/02-Configuration/02-config.md @@ -19,7 +19,7 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou - Logs rotate - Max size: 20MB - Max files: 7 days -- `log_failed_attempts`: boolean +- `log_failed_attempts` (optional): boolean - Whether to log failed authentication attempts. This is useful for security tools like Crowdsec and Fail2ban. ### `server` @@ -72,8 +72,10 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou ### `domains` +At least one domain must be configured. + - ``: string - - The unique key for the domain configuration. + - The unique key for the domain configuration. This can be anything you want. - `base_domain`: string - Example: `example.com` - `cert_resolver`: string @@ -139,6 +141,9 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou - `no_reply` (optional): string - Example: `no-reply@example.com` - The address to send emails from. This can be any email address. Most often this will be the same as the `smtp_user`. +- `smtp_tls_reject_unauthorized` (optional): boolean + - Do not fail if the server certificate cannot be verified. + - Default: `false` ### `users` @@ -176,6 +181,8 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou ## Example Configuration File +This is just an example and is not meant to be used as is. It is not complete. You should customize the configuration to your needs. + ```yaml app: dashboard_url: "https://example.com" diff --git a/packages/docusaurus/docs/03-Pangolin/02-Configuration/03-wildcard-certs.md b/packages/docusaurus/docs/03-Pangolin/02-Configuration/03-wildcard-certs.md index 3b3f955..162ce69 100644 --- a/packages/docusaurus/docs/03-Pangolin/02-Configuration/03-wildcard-certs.md +++ b/packages/docusaurus/docs/03-Pangolin/02-Configuration/03-wildcard-certs.md @@ -14,7 +14,7 @@ It is highly reccommended that you read the [official Traefik documentation](htt ## Benefits of Wildcard Certificates -1. Wildcard certificates allow you to secure your base domain and all subdomains with a single certificate. This reduces the number of certificates you need to manage. +1. Wildcard certificates allow you to secure your all subdomains with a single certificate. This reduces the number of certificates you need to manage. 2. You can add new subdomains to resources without needing to generate a new certificate each time. Without a wildcard certificate, you would need to wait (up to a few minutes usually) for a new certificate to be generated and loaded by Traefik. - For example: A wildcard cert `*.example.com` could protect `api.example.com`, `blog.example.com`, and another `*.subdomain.example.com` could protect `api.subdomain.example.com`, `blog.subdomain.example.com`, etc. 3. The [rate limits](https://letsencrypt.org/docs/rate-limits/) for Let's Encrypt are per domain. Using a wildcard certificate reduces the number of domains you have, which can help you avoid hitting these limits. @@ -147,7 +147,7 @@ You can ensure Traefik doesn't try to use the old certs by deleting the previous Start the stack and watch the logs. You should notice that Traefik is making calls to your DNS provider to create the necessary records to complete the challenge. For debugging purposes, you may find it useful to set the log level of Traefik to `debug` in the `traefik_config.yml` file. -After Traefik is done waiting for the cert to verify. Try to create a new resource with a unused subdomain. Traefik should not try to generated a new certificate, but instead use the wildcard certificate. The domain should also be secured immediately instead of waiting for a new certificate to be generated. +After Traefik is done waiting for the cert to verify, try to create a new resource with an unused subdomain. Traefik should not try to generated a new certificate, but instead use the wildcard certificate. The domain should also be secured immediately instead of waiting for a new certificate to be generated. You can also check the volume (in the example above at `config/letsencrypt/`) for the correct certificates. In the `acme.json` file you should see something similar to the following. Note the `*.` in the domain. diff --git a/packages/docusaurus/docs/03-Pangolin/04-api-documentation.md b/packages/docusaurus/docs/03-Pangolin/04-api-documentation.md index a7f18f2..9d4c140 100644 --- a/packages/docusaurus/docs/03-Pangolin/04-api-documentation.md +++ b/packages/docusaurus/docs/03-Pangolin/04-api-documentation.md @@ -216,18 +216,18 @@ I'll create an improved API documentation based on the files provided. Here's th -d '{"email":"invitee@example.com","roleId":123,"validHours":24,"sendEmail":true}' ``` -### 2. Request/Response Formats +## 2. Request/Response Formats All requests should include the appropriate headers, particularly `Content-Type` set to `application/json` for JSON payloads and an `Authorization` header for authenticated requests. -### 3. Usage Examples +## 3. Usage Examples Examples of how to interact with the API are included in the endpoint descriptions above using `curl`. These examples illustrate how to make requests and handle responses. -### 4. Limitations or Constraints +## 4. Limitations or Constraints - Each email address must be unique when creating a user. - Resources and sites must be associated with an organization, and users must have appropriate permissions to create or manage resources. - Rate limits apply to API calls. -This documentation provides a foundational overview of the API's public endpoints, request/response formats, usage examples, and any limitations. We will expand upon this as our API evolves and we have more time to document endpoints and as additional features are added. \ No newline at end of file +This documentation provides a foundational overview of the API's public endpoints, request/response formats, usage examples, and any limitations. We will expand upon this as our API evolves and we have more time to document endpoints and as additional features are added. diff --git a/packages/docusaurus/docs/06-Newt/01-overview.md b/packages/docusaurus/docs/04-Newt/01-overview.md similarity index 100% rename from packages/docusaurus/docs/06-Newt/01-overview.md rename to packages/docusaurus/docs/04-Newt/01-overview.md diff --git a/packages/docusaurus/docs/06-Newt/02-install.md b/packages/docusaurus/docs/04-Newt/02-install.md similarity index 100% rename from packages/docusaurus/docs/06-Newt/02-install.md rename to packages/docusaurus/docs/04-Newt/02-install.md diff --git a/packages/docusaurus/docs/06-Newt/03-security.md b/packages/docusaurus/docs/04-Newt/03-security.md similarity index 100% rename from packages/docusaurus/docs/06-Newt/03-security.md rename to packages/docusaurus/docs/04-Newt/03-security.md diff --git a/packages/docusaurus/docs/06-Newt/img/preview.png b/packages/docusaurus/docs/04-Newt/img/preview.png similarity index 100% rename from packages/docusaurus/docs/06-Newt/img/preview.png rename to packages/docusaurus/docs/04-Newt/img/preview.png diff --git a/packages/docusaurus/docs/06-Newt/img/unraid_store.png b/packages/docusaurus/docs/04-Newt/img/unraid_store.png similarity index 100% rename from packages/docusaurus/docs/06-Newt/img/unraid_store.png rename to packages/docusaurus/docs/04-Newt/img/unraid_store.png diff --git a/packages/docusaurus/docs/04-Badger/overview.md b/packages/docusaurus/docs/06-Badger/overview.md similarity index 100% rename from packages/docusaurus/docs/04-Badger/overview.md rename to packages/docusaurus/docs/06-Badger/overview.md diff --git a/packages/docusaurus/src/css/custom.css b/packages/docusaurus/src/css/custom.css index 2bff7c7..0379069 100644 --- a/packages/docusaurus/src/css/custom.css +++ b/packages/docusaurus/src/css/custom.css @@ -226,3 +226,11 @@ div[class^="announcementBarContent"] a:hover { display: none !important; } } + +.breadcrumbs li:first-child { + display: none; +} + +.breadcrumbs li:nth-child(2) .breadcrumbs__link{ + padding-left: 0px !important; +}