Feat docs (#1814)
* improve docs and formatting * lint in ci avoid using bundled prettier from vscode extension * fix action, typos * remove header * remove unused deps
This commit is contained in:
@@ -2,4 +2,25 @@
|
||||
title: 2FA
|
||||
---
|
||||
|
||||
TODO
|
||||
The user can enable 2FA from the Account page. The Account page is accessible from the dropdown menu in the top right corner of the application.
|
||||
|
||||
## Enable TOTP
|
||||
|
||||
- **Enable Two Factor Authentication**: Enable TOTP for the user.
|
||||
|
||||
## Configure TOTP
|
||||
|
||||
A QR code will be displayed. Scan the QR code with your TOTP application (e.g., Google Authenticator, Authy, etc.) to add the account.
|
||||
|
||||
To verify that the TOTP key is working, the user must enter the TOTP code generated by the TOTP application.
|
||||
|
||||
- **TOTP Key**: The TOTP key for the user. This key is used to generate the TOTP code.
|
||||
- **TOTP Code**: The current TOTP code for the user. This code is used to verify the TOTP key.
|
||||
- **Enable Two Factor Authentication**: Enable TOTP for the user.
|
||||
|
||||
## Disable TOTP
|
||||
|
||||
To disable TOTP, the user must enter the current password.
|
||||
|
||||
- **Current Password**: The current password of the user.
|
||||
- **Disable Two Factor Authentication**: Disable TOTP for the user.
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: Edit Account
|
||||
---
|
||||
|
||||
TODO
|
||||
@@ -2,4 +2,49 @@
|
||||
title: Edit Client
|
||||
---
|
||||
|
||||
TODO
|
||||
## General
|
||||
|
||||
- **Name**: The name of the client.
|
||||
- **Enabled**: Whether the client can connect to the VPN.
|
||||
- **Expire Date**: The date the client will be disabled.
|
||||
|
||||
## Address
|
||||
|
||||
- **IPv4**: The IPv4 address of the client.
|
||||
- **IPv6**: The IPv6 address of the client.
|
||||
|
||||
## Allowed IPs
|
||||
|
||||
Which IPs will be routed through the VPN.
|
||||
|
||||
This will not prevent the user from modifying it locally and accessing IP ranges that they should not be able to access.
|
||||
|
||||
Use firewall rules to prevent access to IP ranges that the user should not be able to access.
|
||||
|
||||
## Server Allowed IPs
|
||||
|
||||
Which IPs will be routed to the client.
|
||||
|
||||
## DNS
|
||||
|
||||
The DNS server that the client will use.
|
||||
|
||||
## Advanced
|
||||
|
||||
- **MTU**: The maximum transmission unit for the client.
|
||||
- **Persistent Keepalive**: The interval for sending keepalive packets to the server.
|
||||
|
||||
## Hooks
|
||||
|
||||
This can only be used for clients that use `wg-quick`. Setting this will throw a error when importing the config on other clients.
|
||||
|
||||
- **PreUp**: Commands to run before the interface is brought up.
|
||||
- **PostUp**: Commands to run after the interface is brought up.
|
||||
- **PreDown**: Commands to run before the interface is brought down.
|
||||
- **PostDown**: Commands to run after the interface is brought down.
|
||||
|
||||
## Actions
|
||||
|
||||
- **Save**: Save the changes made in the form.
|
||||
- **Revert**: Revert the changes made in the form.
|
||||
- **Delete**: Delete the client.
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: Login
|
||||
---
|
||||
|
||||
TODO
|
||||
Reference in New Issue
Block a user