Skip to content

Commit

Permalink
docs(webauthn): add note regarding non-resident key and username
Browse files Browse the repository at this point in the history
  • Loading branch information
fguillot committed Oct 27, 2024
1 parent 7e94c21 commit e9843e4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
3 changes: 3 additions & 0 deletions content/docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,9 @@ The configuration file is loaded first if specified. Environment variables takes
<dt id="webauthn"><a href="#webauthn"><code>WEBAUTHN</code></a></dt>
<dd>
<p>Enable or disable WebAuthn/Passkey authentication.</p>
<p>
You must enter the username on the login page if you are using a security key (also known as non-resident key in the WebAuthn protocol). This is not required for Passkeys which are discoverable credentials stored in the platform secure enclave, or in a trusted platform module (TPM).
</p>
<p><em>Default is disabled</em></p>
</dd>
<dt id="worker-pool-size"><a href="#worker-pool-size"><code>WORKER_POOL_SIZE</code></a></dt>
Expand Down
5 changes: 4 additions & 1 deletion content/docs/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,14 @@ Here are some examples of configuration:
- [Deploy Miniflux on Heroku](#heroku)
- [Deploy Miniflux on Google App Engine](#gae)

<h2 id="webauthn">How to enable Webauthn / Passkey authentication? <a class="anchor" href="#webauthn" title="Permalink">¶</a></h2>
<h2 id="webauthn">How to enable WebAuthn / Passkey authentication? <a class="anchor" href="#webauthn" title="Permalink">¶</a></h2>

- Define `BASE_URL` with an appropriate value, for example: `https://miniflux.example.org/`. It won't work with an IP address like `127.0.0.1` in some browsers.
- Enable WebAuthn / Passkey: `WEBAUTHN=1`.

**You must enter the username on the login page if you are using a security key (also known as non-resident key in the WebAuthn protocol).**
This is not required for Passkeys which are discoverable credentials stored in the platform secure enclave, or in a trusted platform module (TPM).

<h2 id="pg-unix-socket">Use a Unix socket for Postgresql <a class="anchor" href="#pg-unix-socket" title="Permalink">¶</a></h2>

If you would like to connect via a Unix socket to Postgresql, set the parameter `host=/path/to/socket/folder`.
Expand Down

0 comments on commit e9843e4

Please sign in to comment.