mirror of
https://github.com/h44z/wg-portal.git
synced 2025-06-28 01:07:03 +00:00
be29abd29a
* add webhook event for peer state change (#444) new event types: connect and disconnect example payload: ```json { "event": "connect", "entity": "peer", "identifier": "Fb5TaziAs1WrPBjC/MFbWsIelVXvi0hDKZ3YQM9wmU8=", "payload": { "PeerId": "Fb5TaziAs1WrPBjC/MFbWsIelVXvi0hDKZ3YQM9wmU8=", "IsConnected": true, "IsPingable": false, "LastPing": null, "BytesReceived": 1860, "BytesTransmitted": 10824, "LastHandshake": "2025-06-26T23:04:33.325216659+02:00", "Endpoint": "10.55.66.77:33874", "LastSessionStart": "2025-06-26T22:50:40.10221606+02:00" } } ``` * add webhook docs (#444)
89 lines
2.5 KiB
YAML
89 lines
2.5 KiB
YAML
---
|
|
site_name: WireGuard Portal
|
|
site_description: Manage WireGuard Peers and Interface using a beautiful and simple web UI.
|
|
site_url: https://wgportal.org/
|
|
repo_name: h44z/wg-portal
|
|
repo_url: https://github.com/h44z/wg-portal
|
|
copyright: Copyright © 2023-2025 WireGuard Portal Project
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
theme:
|
|
name: material
|
|
custom_dir: docs/theme-overrides
|
|
palette:
|
|
primary: white
|
|
font: false
|
|
logo: assets/images/logo.svg
|
|
favicon: assets/images/favicon-large.png
|
|
language: en
|
|
features:
|
|
- content.code.copy
|
|
- navigation.instant
|
|
- navigation.tabs
|
|
- navigation.expand
|
|
|
|
plugins:
|
|
- search
|
|
- social
|
|
- minify:
|
|
minify_html: true
|
|
- swagger-ui-tag
|
|
- mike:
|
|
# These fields are all optional; the defaults are as below...
|
|
alias_type: symlink
|
|
redirect_template: null
|
|
deploy_prefix: ''
|
|
canonical_version: null
|
|
version_selector: true
|
|
css_dir: css
|
|
javascript_dir: js
|
|
|
|
extra:
|
|
version:
|
|
provider: mike
|
|
default: latest
|
|
social:
|
|
- icon: fontawesome/brands/github-alt
|
|
link: https://github.com/h44z/wg-portal
|
|
- icon: fontawesome/brands/docker
|
|
link: https://hub.docker.com/r/wgportal/wg-portal
|
|
- icon: fontawesome/brands/twitter
|
|
link: https://twitter.com/chris_h44z
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- meta
|
|
- pymdownx.details
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tilde
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Documentation:
|
|
- Overview: documentation/overview.md
|
|
- Getting Started:
|
|
- Binaries: documentation/getting-started/binaries.md
|
|
- Docker: documentation/getting-started/docker.md
|
|
- Helm: documentation/getting-started/helm.md
|
|
- Sources: documentation/getting-started/sources.md
|
|
- Reverse Proxy (HTTPS): documentation/getting-started/reverse-proxy.md
|
|
- Configuration:
|
|
- Overview: documentation/configuration/overview.md
|
|
- Examples: documentation/configuration/examples.md
|
|
- Usage:
|
|
- General: documentation/usage/general.md
|
|
- LDAP: documentation/usage/ldap.md
|
|
- Security: documentation/usage/security.md
|
|
- Webhooks: documentation/usage/webhooks.md
|
|
- REST API: documentation/rest-api/api-doc.md
|
|
- Upgrade: documentation/upgrade/v1.md
|
|
- Monitoring: documentation/monitoring/prometheus.md
|