truecharts/charts/stable/firezone/docs/installation_notes.md at master

Files

Stavros Kois 12b5c56b24 chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589 )

**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ Fixes  # <!--(issue)-->

front matter is supported by all doc sites (including github markdown
rendering
and is easier to add extra metadata later on, if we want to.

```
---
title: sometitle
---
```

**⚙️ Type of change**

- [ ] ⚙️ 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?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 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
- [ ] ⬆️ 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._

2023-12-31 16:24:05 +02:00

1.0 KiB

Raw Permalink Blame History

title

title
Installation Notes

How to setup FireZone.

Web Configuration

Set a External Url to a valid FQDN; https://app.mydomain.tld.
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.

1.0 KiB Raw Permalink Blame History

Web Configuration

Admin Configuration

Devices Configuration

1.0 KiB

Raw Permalink Blame History