[docs] big bang update (#348)

* [docs] big bang update

* Simplified polluted README.md by moving parts to the documentation
* Removed duplicates with `pymdownx.snippets` extension
* Enabled code copy
* Extended "Getting Started"
* Added "Monitoring" page
* Separated "Upgrade" page
* Added default config yaml to docs

Signed-off-by: Dmytro Bondar <git@bonddim.dev>

* Update sources.md

Co-authored-by: h44z <christoph.h@sprinternet.at>

---------

Signed-off-by: Dmytro Bondar <git@bonddim.dev>
Co-authored-by: h44z <christoph.h@sprinternet.at>

docs/documentation/getting-started/binaries.md

@@ -0,0 +1,34 @@
+Starting from v2, each [release](https://github.com/h44z/wg-portal/releases) includes compiled binaries for supported platforms.
+These binary versions can be manually downloaded and installed.
+
+## Download
+
+With `curl`:
+
+  ```shell
+  curl -L -o wg-portal https://github.com/h44z/wg-portal/releases/download/${WG_PORTAL_VERSION}/wg-portal_linux_amd64 
+  ```
+
+With `wget`:
+
+  ```shell
+  wget -O wg-portal https://github.com/h44z/wg-portal/releases/download/${WG_PORTAL_VERSION}/wg-portal_linux_amd64
+  ```
+
+with `gh cli`:
+
+  ```shell
+  gh release download ${WG_PORTAL_VERSION} --repo h44z/wg-portal --output wg-portal --pattern '*amd64'
+  ```
+
+## Install
+
+```shell
+sudo mkdir -p /opt/wg-portal
+sudo install wg-portal /opt/wg-portal/
+```
+
+## Unreleased
+
+Unreleased versions could be downloaded from
+[GitHub Workflow](https://github.com/h44z/wg-portal/actions/workflows/docker-publish.yml?query=branch%3Amaster) artifacs also.

docs/documentation/getting-started/building.md

@@ -1,11 +0,0 @@
-To build a standalone application, use the Makefile provided in the repository.
-Go version **1.23** or higher has to be installed to build WireGuard Portal.
-If you want to re-compile the frontend, NodeJS **18** and NPM >= **9** is required.
-
-```shell
-# build the frontend (optional)
-make frontend
-
-# build the binary
-make build
-```

docs/documentation/getting-started/docker.md

@@ -5,20 +5,7 @@ The preferred way to start WireGuard Portal as Docker container is to use Docker
 A sample docker-compose.yml:
 
 ```yaml
-version: '3.6'
-services:
-  wg-portal:
-    image: wgportal/wg-portal:latest
-    restart: unless-stopped
-    cap_add:
-      - NET_ADMIN
-    network_mode: "host"
-    ports:
-      - "8888:8888"
-    volumes:
-      - /etc/wireguard:/etc/wireguard
-      - ./data:/app/data
-      - ./config:/app/config
+--8<-- "docker-compose.yml::17"
 ```
 
 By default, the webserver is listening on port **8888**.
@@ -31,6 +18,7 @@ All images are hosted on Docker Hub at [https://hub.docker.com/r/wgportal/wg-por
 There are three types of tags in the repository:
 
 #### Semantic versioned tags
+
 For example, `1.0.19`.
 
 These are official releases of WireGuard Portal. They correspond to the GitHub tags that we make, and you can see the release notes for them here: [https://github.com/h44z/wg-portal/releases](https://github.com/h44z/wg-portal/releases).
@@ -44,16 +32,17 @@ If you only want to stay at the same major or major+minor version, use either `v
 Version **1** is currently **stable**, version **2** is in **development**.
 
 #### latest
+
 This is the most recent build to master! It changes a lot and is very unstable.
 
 We recommend that you don't use it except for development purposes.
 
 #### Branch tags
+
 For each commit in the master and the stable branch, a corresponding Docker image is build. These images use the `master` or `stable` tags.
 
-
-
 ## Configuration
+
 You can configure WireGuard Portal using a yaml configuration file.
 The filepath of the yaml configuration file defaults to `/app/config/config.yml`.
 It is possible to override the configuration filepath using the environment variable **WG_PORTAL_CONFIG**.
@@ -61,6 +50,7 @@ It is possible to override the configuration filepath using the environment vari
 By default, WireGuard Portal uses a SQLite database. The database is stored in `/app/data/sqlite.db`.
 
 You should mount those directories as a volume:
+
 - /app/data
 - /app/config
 

docs/documentation/getting-started/kubernetes.md

@@ -0,0 +1 @@
+--8<-- "./deploy/helm/README.md:16"

docs/documentation/getting-started/sources.md

@@ -0,0 +1,24 @@
+To build the application from source files, use the Makefile provided in the repository.
+
+## Requirements
+
+- [Git](https://git-scm.com/downloads)
+- [Make](https://www.gnu.org/software/make/)
+- [Go](https://go.dev/dl/): `>=1.23.0`
+- [NodeJS with npm](https://nodejs.org/en/download): `node>=18, npm>=9`
+
+## Build
+
+```shell
+# Get source code
+git clone https://github.com/h44z/wg-portal -b ${WG_PORTAL_VERSION:-master} --depth 1
+cd wg-portal
+# Build the frontend
+make frontend
+# Build the backend
+make build
+```
+
+## Install
+
+Compiled binary will be available in `./dist` directory.

docs/documentation/getting-started/upgrade.md

@@ -1,36 +0,0 @@
-For production deployments of WireGuard Portal, we strongly recommend using version 1. 
-If you want to use version 2, please be aware that it is still in beta and not feature complete.
-
-## Upgrade from v1 to v2
-
-> :warning: Before upgrading from V1, make sure that you have a backup of your currently working configuration files and database!
-
-To start the upgrade process, start the wg-portal binary with the **-migrateFrom** parameter.
-The configuration (config.yml) for WireGuard Portal must be updated and valid before starting the upgrade.
-
-To upgrade from a previous SQLite database, start wg-portal like:
-
-```shell
-./wg-portal-amd64 -migrateFrom=old_wg_portal.db
-```
-
-You can also specify the database type using the parameter **-migrateFromType**, supported types: mysql, mssql, postgres or sqlite.
-For example:
-
-```shell
-./wg-portal-amd64 -migrateFromType=mysql -migrateFrom=user:pass@tcp(1.2.3.4:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local
-```
-
-The upgrade will transform the old, existing database and store the values in the new database specified in the **config.yml** configuration file.
-Ensure that the new database does not contain any data!
-
-If you are using Docker, you can adapt the docker-compose.yml file to start the upgrade process:
-
-```yaml
-services:
-  wg-portal:
-    image: wgportal/wg-portal:latest
-    # ... other settings
-    restart: no
-    command: ["-migrateFrom=/app/data/wg_portal.db"]
-```