Client Side App
The new client side app is under clients
of your WGDashboard. If your WGD is in https://wgd.com
, then client side app is in https://wgd.com/client
Usage
Enable / Disable
By default, client side app is enabled, but if you don't need this feature, you can head to Clients > Settings > Enable Client Side App and toggle it off
Sign In / Up
Currently, we offer 2 ways to sign in: Email & Password or OIDC
Sign In / Up Using Email & Password
If you have not signed up, click on the Sign Up button and follow the form, once you're done, click Continue button to finish.
To sign in, Simply enter the email password you signed up earlier, if your credentials are correct, you will be prompt to enter a TOTP.
Sign In / Up Using OIDC
There is no need to sign up when using OIDC, WGDashboard will automatically sign up users when they first sign in with their OIDC provider
Configure OIDC
Currently, you will need to manually edit wg-dashboard-oidc-providers.json
under WGDashboard/src
Once you opened, you should see something like this, with an example Object Provider
:
To add a new OIDC provider, simply rename Provider
to a name you want, then fill in the rest 3 required fields: client_id
, client_secret
and issuer
For example, I'm using authentik and created a OIDC provider:
Then save the file and restart WGDashboard, and if your OIDC provider is valid, you should see an output when restarting WGD like this:
and if you visit http://wgd_host:port/client
, you should see a button on the sign in page to allow you to sign in with your provider.
Manage Clients
You should see all signed up clients in the Clients page of WGDashboard. Click on the client's name and should be quite straight forward to setup your clients.
You can do the following:
Update Client's name
Assign Peers
Click on the blue Manage button
You should see a list of available peers popped up
Click on the green Plus button next to each peer to assign it to the client
Unassign Peer
Simply click on the red Trash Bin button to unassign
Delete Client
If you delete a local clients, all information will get remove
If you delete an OIDC client, all information will get remove, but it still able to sign back in unless you removed permission to access on the OIDC provider.
Assign Peer to clients on Peers List
You can also assign clients on peers list.
Simply click on the 3-dots dropdown on each peer in a configuration, you should see a menu option Assign Peer.
Then you can choose which client should have the access to this peer but clicking the green Plus button, or remove access by clicking the red Trash Bin button.