Browse Source

improve docs

pull/1702/head
Bernd Storath 5 months ago
parent
commit
a249a064a5
  1. 2
      README.md
  2. 5
      docs/content/advanced/api.md
  3. 0
      docs/content/advanced/config/optional-config.md
  4. 0
      docs/content/advanced/migrate/from-14-to-15.md
  5. 4
      docs/content/examples/tutorials/basic-installation.md
  6. 6
      docs/content/getting-started.md

2
README.md

@ -36,7 +36,7 @@ You have found the easiest way to install & manage WireGuard on any Linux host!
> [!NOTE]
> To better manage documentation for this project, it has its own site here: [https://wg-easy.github.io/wg-easy/latest](https://wg-easy.github.io/wg-easy/latest)
- [Get Started](https://wg-easy.github.io/wg-easy/latest/usage/)
- [Getting Started](https://wg-easy.github.io/wg-easy/latest/getting-started/)
- [Basic Installation](https://wg-easy.github.io/wg-easy/latest/examples/tutorials/basic-installation/)
## Requirements

5
docs/content/advanced/api.md

@ -0,0 +1,5 @@
---
title: API
---
TODO

0
docs/content/config/advanced/optional-config.md → docs/content/advanced/config/optional-config.md

0
docs/content/config/migrate/from-14-to-15.md → docs/content/advanced/migrate/from-14-to-15.md

4
docs/content/examples/tutorials/basic-installation.md

@ -45,6 +45,10 @@ If you are using a firewall, you need to open the following ports:
These ports can be changed, so if you change them you have to update your firewall rules accordingly.
## Setup Reverse Proxy
TODO
## Access the Web UI
Open your browser and navigate to `https://<your-domain>:51821` or `https://<your-ip>:51821`.

6
docs/content/usage.md → docs/content/getting-started.md

@ -1,5 +1,5 @@
---
title: Usage
title: Getting Started
hide:
- navigation
---
@ -86,3 +86,7 @@ sudo docker compose down
///
**That's it! It really is that easy**.
If you need more help you can read the [Basic Installation Tutorial][basic-installation].
[basic-installation]: ./examples/tutorials/basic-installation.md
Loading…
Cancel
Save