mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-10-03 11:19:08 +02:00
add community blueprints page
This commit is contained in:
@@ -133,7 +133,14 @@
|
|||||||
"manage/analytics/streaming"
|
"manage/analytics/streaming"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"manage/blueprints",
|
{
|
||||||
|
"group": "Blueprints",
|
||||||
|
"icon": "file-code",
|
||||||
|
"pages": [
|
||||||
|
"manage/blueprints",
|
||||||
|
"manage/community-blueprints-repo"
|
||||||
|
]
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"group": "Remote Nodes",
|
"group": "Remote Nodes",
|
||||||
"icon": "circle-nodes",
|
"icon": "circle-nodes",
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: "Blueprints"
|
title: "Blueprints"
|
||||||
icon: "file-code"
|
|
||||||
description: "Pangolin Blueprints are declarative configurations that allow you to define your resources and their settings in a structured format"
|
description: "Pangolin Blueprints are declarative configurations that allow you to define your resources and their settings in a structured format"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,71 @@
|
|||||||
|
---
|
||||||
|
title: "Community Blueprints"
|
||||||
|
description: "Community-maintained library of ready-to-use Pangolin Blueprints for self-hosted applications"
|
||||||
|
---
|
||||||
|
|
||||||
|
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||||
|
|
||||||
|
<PangolinCloudTocCta />
|
||||||
|
|
||||||
|
The Pangolin Community Blueprints repository is a shared library of ready-to-use Docker Compose templates for common self-hosted services, already wired to expose those services through Pangolin.
|
||||||
|
|
||||||
|
<Card icon="github" arrow="true" cta="View repository" href="https://github.com/fosrl/blueprints">
|
||||||
|
View the repository on GitHub to browse the available blueprints and learn more: [github.com/fosrl/blueprints](https://github.com/fosrl/blueprints)
|
||||||
|
</Card>
|
||||||
|
|
||||||
|
## Why this repository exists
|
||||||
|
|
||||||
|
When people self-host, the hardest part is often not the app itself, it is the networking, exposure, and access control around it.
|
||||||
|
|
||||||
|
This repository exists to package those patterns into reusable blueprints so you can:
|
||||||
|
|
||||||
|
- start from known-good templates for popular services
|
||||||
|
- avoid repetitive reverse proxy and exposure configuration
|
||||||
|
- apply secure defaults like SSO-oriented access patterns
|
||||||
|
- make deployments more consistent across environments
|
||||||
|
- share and improve blueprints as a community
|
||||||
|
|
||||||
|
## What you get
|
||||||
|
|
||||||
|
Each service blueprint includes pre-defined labels and structure that map to Pangolin resources, so bringing a service up can create and configure its exposure model with minimal dashboard work.
|
||||||
|
|
||||||
|
Common examples include:
|
||||||
|
|
||||||
|
- Grafana
|
||||||
|
- Homepage
|
||||||
|
- Immich
|
||||||
|
- Jellyfin
|
||||||
|
- and more community-contributed services
|
||||||
|
|
||||||
|
Browse the full, current list in the repository:
|
||||||
|
|
||||||
|
- [View available services](https://github.com/fosrl/blueprints/tree/main/services)
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
At a high level, getting started looks like this:
|
||||||
|
|
||||||
|
1. Create a Pangolin Cloud account (or use your self-hosted Pangolin) and set up a site.
|
||||||
|
2. Copy your site connector values (`NEWT_ID` and `NEWT_SECRET`) and set your base domain.
|
||||||
|
3. Clone the community blueprints repository and configure the root `.env`.
|
||||||
|
4. Initialize and run a service blueprint.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/fosrl/blueprints
|
||||||
|
cd blueprints
|
||||||
|
./bin/blueprint list
|
||||||
|
./bin/blueprint init <service>
|
||||||
|
./bin/blueprint up <service>
|
||||||
|
```
|
||||||
|
|
||||||
|
For complete setup details and all command options, use the repository docs directly:
|
||||||
|
|
||||||
|
- [README and full quick start](https://github.com/fosrl/blueprints#readme)
|
||||||
|
|
||||||
|
## Contribute and learn more
|
||||||
|
|
||||||
|
The repository is community-driven. If a service you use is missing, you can propose or contribute a blueprint.
|
||||||
|
|
||||||
|
- [Repository](https://github.com/fosrl/blueprints)
|
||||||
|
- [Contributing guide](https://github.com/fosrl/blueprints/blob/main/CONTRIBUTING.md)
|
||||||
|
- [Community guide](https://github.com/fosrl/blueprints/blob/main/COMMUNITY.md)
|
||||||
Reference in New Issue
Block a user