diff --git a/master/documentation/getting-started/sources/index.html b/master/documentation/getting-started/sources/index.html index b0b3350..db5e063 100644 --- a/master/documentation/getting-started/sources/index.html +++ b/master/documentation/getting-started/sources/index.html @@ -1,5 +1,5 @@ - Sources - WireGuard Portal
Skip to content

Sources

To build the application from source files, use the Makefile provided in the repository.

Requirements

Build

# Get source code
+ Sources - WireGuard Portal      
 
  
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
 
Sources
 
To build the application from source files, use the Makefile provided in the repository.
 
Requirements
  
Build
 
# Get source code
 git clone https://github.com/h44z/wg-portal -b ${WG_PORTAL_VERSION:-master} --depth 1
 cd wg-portal
 # Build the frontend
diff --git a/master/documentation/monitoring/prometheus/index.html b/master/documentation/monitoring/prometheus/index.html
index 66f842d..b1c438e 100644
--- a/master/documentation/monitoring/prometheus/index.html
+++ b/master/documentation/monitoring/prometheus/index.html
@@ -1,5 +1,5 @@
 
- Monitoring - WireGuard Portal      
 
  
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
 
By default WG-Portal exposes Prometheus metrics on port 8787 if interface/peer statistic data collection is enabled.
 
Exposed Metrics
 
  
 Metric Type Description 
   
 wireguard_interface_received_bytes_total gauge Bytes received through the interface. 
 
 wireguard_interface_sent_bytes_total gauge Bytes sent through the interface. 
 
 wireguard_peer_last_handshake_seconds gauge Seconds from the last handshake with the peer. 
 
 wireguard_peer_received_bytes_total gauge Bytes received from the peer. 
 
 wireguard_peer_sent_bytes_total gauge Bytes sent to the peer. 
 
 wireguard_peer_up gauge Peer connection state (boolean: 1/0). 
  
 
Prometheus Config
 
Add following scrape job to your Prometheus config file:
 
# prometheus.yaml
+ Monitoring - WireGuard Portal      
 
  
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
 
By default, WG-Portal exposes Prometheus metrics on port 8787 if interface/peer statistic data collection is enabled.
 
Exposed Metrics
 
  
 Metric Type Description 
   
 wireguard_interface_received_bytes_total gauge Bytes received through the interface. 
 
 wireguard_interface_sent_bytes_total gauge Bytes sent through the interface. 
 
 wireguard_peer_last_handshake_seconds gauge Seconds from the last handshake with the peer. 
 
 wireguard_peer_received_bytes_total gauge Bytes received from the peer. 
 
 wireguard_peer_sent_bytes_total gauge Bytes sent to the peer. 
 
 wireguard_peer_up gauge Peer connection state (boolean: 1/0). 
  
 
Prometheus Config
 
Add following scrape job to your Prometheus config file:
 
# prometheus.yaml
 scrape_configs:
   - job_name: wg-portal
     scrape_interval: 60s
diff --git a/master/documentation/overview/index.html b/master/documentation/overview/index.html
index c90ea07..3af57a0 100644
--- a/master/documentation/overview/index.html
+++ b/master/documentation/overview/index.html
@@ -1,5 +1,5 @@
 
- Overview - WireGuard Portal      
 
  
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
 
Overview
  
WireGuard Portal is a simple, web-based configuration portal for WireGuard server management. The portal uses the WireGuard wgctrl library to manage existing VPN interfaces. This allows for the seamless activation or deactivation of new users without disturbing existing VPN connections.
 
The configuration portal supports using a database (SQLite, MySQL, MsSQL or Postgres), OAuth or LDAP (Active Directory or OpenLDAP) as a user source for authentication and profile data.
 
Features
 
     
  • Self-hosted - the whole application is a single binary
    •  
  • Responsive multi-language web UI written in Vue.JS
    •  
  • Automatically selects IP from the network pool assigned to the client
    •  
  • QR-Code for convenient mobile client configuration
    •  
  • Sends email to the client with QR-code and client config
    •  
  • Enable / Disable clients seamlessly
    •  
  • Generation of wg-quick configuration file (wgX.conf) if required
    •  
  • User authentication (database, OAuth, or LDAP)
    •  
  • IPv6 ready
    •  
  • Docker ready
    •  
  • Can be used with existing WireGuard setups
    •  
  • Support for multiple WireGuard interfaces
    •  
  • Peer Expiry Feature
    •  
  • Handles route and DNS settings like wg-quick does
    •  
  • Exposes Prometheus metrics for monitoring and alertingt
    •  
  • REST API for management and client deployment
    •  
 
 
  
 
   
 
 
 
         
 
  
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
 
Overview
  
WireGuard Portal is a simple, web-based configuration portal for WireGuard server management. The portal uses the WireGuard wgctrl library to manage existing VPN interfaces. This allows for the seamless activation or deactivation of new users without disturbing existing VPN connections.
 
The configuration portal supports using a database (SQLite, MySQL, MsSQL or Postgres), OAuth or LDAP (Active Directory or OpenLDAP) as a user source for authentication and profile data.
 
Features
 
     
  • Self-hosted - the whole application is a single binary
    •  
  • Responsive multi-language web UI written in Vue.js
    •  
  • Automatically selects IP from the network pool assigned to the client
    •  
  • QR-Code for convenient mobile client configuration
    •  
  • Sends email to the client with QR-code and client config
    •  
  • Enable / Disable clients seamlessly
    •  
  • Generation of wg-quick configuration file (wgX.conf) if required
    •  
  • User authentication (database, OAuth, or LDAP)
    •  
  • IPv6 ready
    •  
  • Docker ready
    •  
  • Can be used with existing WireGuard setups
    •  
  • Support for multiple WireGuard interfaces
    •  
  • Peer Expiry Feature
    •  
  • Handles route and DNS settings like wg-quick does
    •  
  • Exposes Prometheus metrics for monitoring and alerting
    •  
  • REST API for management and client deployment
    •