docs(wg-easy): Update docs for PUID issue (#8650)

**Description**

Added docs to prevent/fix this issue

⚒️ Fixes  #8644 

**⚙️ 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?**
<!--
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:**

- [X] ⚖️ 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
- [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._
This commit is contained in:
StevenMcElligott
2023-05-01 09:34:12 +02:00
committed by GitHub
parent ce3dafb8e9
commit 030323d7f5
4 changed files with 23 additions and 6 deletions
+1 -1
View File
@@ -22,7 +22,7 @@ sources:
- https://github.com/truecharts/charts/tree/master/charts/stable/wg-easy - https://github.com/truecharts/charts/tree/master/charts/stable/wg-easy
- https://github.com/WeeJeWel/wg-easy - https://github.com/WeeJeWel/wg-easy
type: application type: application
version: 4.0.0 version: 4.0.1
annotations: annotations:
truecharts.org/catagories: | truecharts.org/catagories: |
- networking - networking
Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

@@ -0,0 +1,11 @@
# WG-Easy Installation Notes
## PUID
This chart requires a `PUID` of `0` to run, however the default is `568`
![PUID](img/wg-easy-PUID.png)
## Setup-Guide
For more details please see the [setup guide](https://truecharts.org/charts/stable/wg-easy/setup-guide) on how to configure the charts and to open ports on your Firewall and/or enable the proper `sysctls` for passing through traffic.
+11 -5
View File
@@ -26,9 +26,7 @@ Set them to `1` and `Enabled`
## Wg-Easy Chart Setup ## Wg-Easy Chart Setup
Step 1-2: Name chart and leave defaults for Step 2 ### Container Configuration
Step 3:
- Change `WG_HOST` _required_ domain name (or WAN IP if you have a Static IP) - Change `WG_HOST` _required_ domain name (or WAN IP if you have a Static IP)
- Change `WG_DEFAULT_ADDRESS` only if it conflicts with other IP addresses on your network - Change `WG_DEFAULT_ADDRESS` only if it conflicts with other IP addresses on your network
@@ -37,13 +35,21 @@ Step 3:
![wg-easy-chart-config](img/wg-easy-chart-config.png) ![wg-easy-chart-config](img/wg-easy-chart-config.png)
Step 4: ### Networking and Services
- The default port for the Wireguard UDP service is `51820` and it needs to be accessible outside your network in order for the Wireguard tunnel to work. Therefore if you change this port make sure you change the port on your Firewall as well. - The default port for the Wireguard UDP service is `51820` and it needs to be accessible outside your network in order for the Wireguard tunnel to work. Therefore if you change this port make sure you change the port on your Firewall as well.
![wg-easy-networking](img/wg-easy-networking.png) ![wg-easy-networking](img/wg-easy-networking.png)
Steps 5-8: Adjust as necessary but defaults are fine unless using Ingress, where you can refer to our [Quick-Start Guides](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/add-ingress) for an overview ### Security and Permissions
:::warning
Must change the `PUID` to 0 for this chart to work
:::
![WG-easy PUID](img/wg-easy-PUID.png)
> **Recommended** If you're creating multiple users setting up Ingress for the Portal/GUI page is a secure and easy way to download your Wireguard configs or use the handy QR code scanner from your mobile device with the Wireguard app on iOS or Android. > **Recommended** If you're creating multiple users setting up Ingress for the Portal/GUI page is a secure and easy way to download your Wireguard configs or use the handy QR code scanner from your mobile device with the Wireguard app on iOS or Android.
> >