From 0b55b2ed12cba84aa9c585062547999a23a6cb30 Mon Sep 17 00:00:00 2001 From: Xstar97TheNoob <9399967+xstar97@users.noreply.github.com> Date: Fri, 22 Sep 2023 18:42:16 -0400 Subject: [PATCH] feat(firezone) move firezone to stable. (#12778) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** Move firezone to stable ⚒️ Fixes # **⚙️ Type of change** - [X] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [X] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [X] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --- .../firezone/.helmignore | 0 .../firezone/CHANGELOG.md | 0 .../{incubator => stable}/firezone/Chart.yaml | 6 ++-- .../{incubator => stable}/firezone/README.md | 0 .../firezone/docs/installation_notes.md | 30 ++++++++++++++++++ .../{incubator => stable}/firezone/icon.png | Bin .../firezone/questions.yaml | 5 +-- .../firezone/templates/NOTES.txt | 0 .../firezone/templates/_secrets.tpl | 0 .../firezone/templates/common.yaml | 0 .../firezone/values.yaml | 0 11 files changed, 36 insertions(+), 5 deletions(-) rename charts/{incubator => stable}/firezone/.helmignore (100%) rename charts/{incubator => stable}/firezone/CHANGELOG.md (100%) rename charts/{incubator => stable}/firezone/Chart.yaml (81%) rename charts/{incubator => stable}/firezone/README.md (100%) create mode 100644 charts/stable/firezone/docs/installation_notes.md rename charts/{incubator => stable}/firezone/icon.png (100%) rename charts/{incubator => stable}/firezone/questions.yaml (98%) rename charts/{incubator => stable}/firezone/templates/NOTES.txt (100%) rename charts/{incubator => stable}/firezone/templates/_secrets.tpl (100%) rename charts/{incubator => stable}/firezone/templates/common.yaml (100%) rename charts/{incubator => stable}/firezone/values.yaml (100%) diff --git a/charts/incubator/firezone/.helmignore b/charts/stable/firezone/.helmignore similarity index 100% rename from charts/incubator/firezone/.helmignore rename to charts/stable/firezone/.helmignore diff --git a/charts/incubator/firezone/CHANGELOG.md b/charts/stable/firezone/CHANGELOG.md similarity index 100% rename from charts/incubator/firezone/CHANGELOG.md rename to charts/stable/firezone/CHANGELOG.md diff --git a/charts/incubator/firezone/Chart.yaml b/charts/stable/firezone/Chart.yaml similarity index 81% rename from charts/incubator/firezone/Chart.yaml rename to charts/stable/firezone/Chart.yaml index c1093449341..084b8042704 100644 --- a/charts/incubator/firezone/Chart.yaml +++ b/charts/stable/firezone/Chart.yaml @@ -6,7 +6,7 @@ dependencies: version: 14.0.3 deprecated: false description: WireGuard-based VPN server and egress firewall -home: https://truecharts.org/charts/incubator/firezone +home: https://truecharts.org/charts/stable/firezone icon: https://truecharts.org/img/hotlink-ok/chart-icons/firezone.png keywords: - firezone @@ -19,10 +19,10 @@ maintainers: url: https://truecharts.org name: firezone sources: - - https://github.com/truecharts/charts/tree/master/charts/incubator/firezone + - https://github.com/truecharts/charts/tree/master/charts/stable/firezone - https://github.com/firezone/firezone type: application -version: 0.2.1 +version: 0.2.2 annotations: truecharts.org/catagories: | - vpn diff --git a/charts/incubator/firezone/README.md b/charts/stable/firezone/README.md similarity index 100% rename from charts/incubator/firezone/README.md rename to charts/stable/firezone/README.md diff --git a/charts/stable/firezone/docs/installation_notes.md b/charts/stable/firezone/docs/installation_notes.md new file mode 100644 index 00000000000..b6a7fde9e4f --- /dev/null +++ b/charts/stable/firezone/docs/installation_notes.md @@ -0,0 +1,30 @@ +# Installation Notes + +How to setup FireZone. + +## Web Configuration + +- Set a `External Url` to a valid FQDN; "". +- Set a `Trusted Proxies` a single IP for your traefik instance(s) on each box. + +## Admin Configuration + +- Keep `Reset Admin On Boot` true. +- Set a `Default Email` and a `Default Password` to login into the web GUI. + +## Devices Configuration + +Most configuration can be left default here but some you want to change. + +- Set `Default Client MTU` to a size that works for _your_ network, default is 1280. +- Set `Client Endpoint` to any of the following, if using a domain it needs to resolve to your public IP so it can not be proxied on CloudFlare. + + - publicIP:WG_PORT + - app.domain.tld:WG_PORT + - domain.tld:WG_PORT + +- Set `Client DNS` to just your local DNS server to have a working split dns within your vpn. + +- Set `Client Allowed Ips` to a range of IPs. + - `0.0.0.0/0` will resolved everything. + - `appsIP/32` will resolve just the app domains only. diff --git a/charts/incubator/firezone/icon.png b/charts/stable/firezone/icon.png similarity index 100% rename from charts/incubator/firezone/icon.png rename to charts/stable/firezone/icon.png diff --git a/charts/incubator/firezone/questions.yaml b/charts/stable/firezone/questions.yaml similarity index 98% rename from charts/incubator/firezone/questions.yaml rename to charts/stable/firezone/questions.yaml index 49d1f485daa..db3fcbb0c04 100644 --- a/charts/incubator/firezone/questions.yaml +++ b/charts/stable/firezone/questions.yaml @@ -77,7 +77,7 @@ questions: description: to create or reset the admin password every time Firezone starts. By default, the admin password is only set when Firezone is installed. schema: type: boolean - default: false + default: true - variable: default_email label: Default Email description: Primary administrator email. @@ -131,9 +131,10 @@ questions: default: 1280 - variable: client_endpoint label: Client Endpoint - description: IPv4, IPv6 address, or FQDN that devices will be configured to connect to. + description: IPv4 address, or FQDN that devices will be configured to connect to. schema: type: string + required: true default: "" - variable: client_dns label: Client DNS diff --git a/charts/incubator/firezone/templates/NOTES.txt b/charts/stable/firezone/templates/NOTES.txt similarity index 100% rename from charts/incubator/firezone/templates/NOTES.txt rename to charts/stable/firezone/templates/NOTES.txt diff --git a/charts/incubator/firezone/templates/_secrets.tpl b/charts/stable/firezone/templates/_secrets.tpl similarity index 100% rename from charts/incubator/firezone/templates/_secrets.tpl rename to charts/stable/firezone/templates/_secrets.tpl diff --git a/charts/incubator/firezone/templates/common.yaml b/charts/stable/firezone/templates/common.yaml similarity index 100% rename from charts/incubator/firezone/templates/common.yaml rename to charts/stable/firezone/templates/common.yaml diff --git a/charts/incubator/firezone/values.yaml b/charts/stable/firezone/values.yaml similarity index 100% rename from charts/incubator/firezone/values.yaml rename to charts/stable/firezone/values.yaml