Add user guides

This commit is contained in:
Jason Gong
2022-02-04 10:48:50 -08:00
parent bf6c1cbd6b
commit 569a5221ff
7 changed files with 38 additions and 13 deletions

View File

@@ -37,6 +37,8 @@ h1, h2, h3, h4, h5, h6 {
$border-color: $fz-grey-lt-200;
// Container
$content-width: 1100px;
$media-queries: (
xs: 620px,

View File

@@ -1,6 +1,6 @@
---
layout: default
title: Reference
nav_order: 4
nav_order: 5
has_children: true
---

View File

@@ -1,9 +0,0 @@
---
layout: default
title: Add Users
nav_order: 1
parent: User Guides
---
Add a user through the Web UI by clicking the "Add User" button under
`/users`

View File

@@ -6,5 +6,12 @@ parent: User Guides
---
Add a device through the Web UI by clicking the "Add Device" button under
`/devices` or `/users`. Once the device profile is created, you can send the
WireGuard configuration file to the user.
`/devices` or `/users`.
![add device](https://user-images.githubusercontent.com/52545545/152582102-7bde379a-57d5-4f35-9b4e-4d02c32241bc.png)
Once the device profile is created, you can send the WireGuard configuration file to the user by:
* **Shareable Link**: Generates a time limited link to the device config file that can be.
* **Download Config**: Downloads the device config file to your local machine to be sent securely to the user.
Devices are associated with users. See [Add Users](/docs/user-guides/add-users.md) for more information on how to add a user.

View File

@@ -0,0 +1,15 @@
---
layout: default
title: Add Users
nav_order: 1
parent: User Guides
---
Once you have successfully installed Firezone you'll need to add users to grant them access to your network. This is done through the Web UI.
### Web UI
Add a user by clicking the "Add User" button under `/users`. You will be asked to specify an email and a password for the user. These credentials will be used to authenticate the user so they are able to establish the connection.
![add user](https://user-images.githubusercontent.com/52545545/152580539-bdf10332-a528-4650-a0fe-e72bca89e98a.png)
Next, [add devices](/docs/user-guides/add-devices.md) to the user.

View File

@@ -0,0 +1,10 @@
---
layout: default
title: Firewall Rules
nav_order: 3
parent: User Guides
---
Firezone supports egress filtering controls. By default, all traffic is allowed.
![firewall rules](https://user-images.githubusercontent.com/52545545/152583668-99077cb3-f83b-4ca4-8641-2e8b2ae5d061.png)

View File

@@ -1,6 +1,6 @@
---
layout: default
title: User Guides
nav_order: 5
nav_order: 4
has_children: true
---