Mirrors/wg-portal
1
0
Fork 0
mirror of https://github.com/h44z/wg-portal.git synced 2026-06-15 14:28:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Deployed dea358c to master with MkDocs 1.6.1 and mike 2.2.0

Browse Source
This commit is contained in:
github-actions[bot]
2026-05-29 19:56:27 +00:00
parent 67ba6c23ad
commit 1cca238ffd
4 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
master/documentation/usage/backends/index.html
View File

@@ -12,7 +12,7 @@
<span class=w> </span><span class=nt>api_timeout</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">30s</span><span class=w> </span><span class=c1># maximum request duration</span>
<span class=w> </span><span class=nt>concurrency</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">5</span><span class=w> </span><span class=c1># limit parallel REST calls to device</span>
<span class=w> </span><span class=nt>debug</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">false</span><span class=w> </span><span class=c1># verbose logging for this backend</span>
</code></pre></div> <h3 id=known-limitations>Known limitations:</h3> <ul> <li>The MikroTik backend is still in beta. Some features may not work as expected.</li> <li>Not all WireGuard Portal features are supported yet (e.g., no support for interface hooks)</li> </ul> <h2 id=configuring-pfsense-backends>Configuring pfSense backends</h2> <blockquote> <p><img alt=⚠ class=twemoji src=https://cdn.jsdelivr.net/gh/jdecked/twemoji@16.0.1/assets/svg/26a0.svg title=:warning:> The pfSense backend is currently <strong>alpha</strong>. Only basic interface and peer CRUD are supported. Traffic statistics (rx/tx, last handshake) are not exposed by the pfSense REST API and will show as empty.</p> </blockquote> <p>The pfSense backend talks to the pfSense REST API (pfSense Plus / CE with the REST API package installed). Point the backend at the appliance hostname without appending <code>/api/v2</code> — the portal appends <code>/api/v2</code> automatically.</p> <h3 id=prerequisites-on-pfsense>Prerequisites on pfSense:</h3> <ul> <li>pfSense with the REST API package enabled (<code>System -&gt; API</code>) and WireGuard configured.</li> <li>An API key with permissions for WireGuard endpoints. If you use a read-only key, set <code>core.restore_state: false</code> in <code>config.yml</code> to avoid write attempts at startup.</li> <li>HTTPS recommended; set <code>api_verify_tls: false</code> only for lab/self-signed setups.</li> </ul> <p>Example WireGuard Portal configuration:</p> <div class=highlight><pre><span></span><code><span class=nt>backend</span><span class=p>:</span>
</code></pre></div> <h3 id=known-limitations>Known limitations:</h3> <ul> <li>The MikroTik backend is still in beta. Some features may not work as expected.</li> <li>Not all WireGuard Portal features are supported yet (e.g., no support for interface hooks)</li> </ul> <h2 id=configuring-pfsense-backends>Configuring pfSense backends</h2> <blockquote> <p><img alt=⚠ class=twemoji src=https://cdn.jsdelivr.net/gh/jdecked/twemoji@16.0.1/assets/svg/26a0.svg title=:warning:> The pfSense backend is currently <strong>alpha</strong>. Only basic interface and peer CRUD are supported. Traffic statistics (rx/tx, last handshake) are not exposed by the pfSense REST API and will show as empty.</p> </blockquote> <p>The pfSense backend talks to the pfSense REST API (pfSense Plus / CE with the REST API package installed). Point the backend at the appliance hostname without appending <code>/api/v2</code> — the portal appends <code>/api/v2</code> automatically. wg-portal is developed for and tested against REST API v2.8.0.</p> <h3 id=prerequisites-on-pfsense>Prerequisites on pfSense:</h3> <ul> <li>pfSense with the REST API package enabled (<code>System -&gt; API</code>) and WireGuard configured.</li> <li>An API key with permissions for WireGuard endpoints. If you use a read-only key, set <code>core.restore_state: false</code> in <code>config.yml</code> to avoid write attempts at startup.</li> <li>HTTPS recommended; set <code>api_verify_tls: false</code> only for lab/self-signed setups.</li> </ul> <p>Example WireGuard Portal configuration:</p> <div class=highlight><pre><span></span><code><span class=nt>backend</span><span class=p>:</span>
<span class=w> </span><span class=c1># default backend decides where new interfaces are created</span>
<span class=w> </span><span class=nt>default</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">pfsense1</span>