Skip to content

Commit b0668f0

Browse files
committed
admin auth refresh
1 parent 5074896 commit b0668f0

File tree

4 files changed

+68
-16
lines changed

4 files changed

+68
-16
lines changed

.vitepress/config.mts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -619,8 +619,13 @@ export default withMermaid(defineConfig({
619619
text: 'Admin',
620620
link: '/apps/admin/',
621621
items : [
622-
{ text: 'Creating Account', link: '/apps/admin/creating-account' },
623-
{ text: 'Permissions', link: '/apps/admin/permissions' },
622+
{ text: 'Authentication', link: '/apps/admin/authentication',
623+
items: [
624+
{ text: 'Account Creation', link: '/apps/admin/authentication#creating-an-account' },
625+
{ text: 'Logging In', link: '/apps/admin/authentication#logging-in' },
626+
{ text: 'Permissions', link: '/apps/admin/authentication#permissions' },
627+
]
628+
},
624629
{ text: 'Devices', link: '/apps/admin/devices' },
625630
{ text: 'Configs', link: '/apps/admin/configs' },
626631
{ text: 'Users', link: '/apps/admin/users' },

.vitepress/theme/Layout.vue

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ const redirects = Object.entries({
1414
'/guides/troubleshooting': '/faq/troubleshooting',
1515
'/devices/legacy': '/devices/history',
1616
'/devices/api/parse': '/devices/api/tools/parse',
17-
'/devices/api/generate': '/devices/api/tools/generate'
17+
'/devices/api/generate': '/devices/api/tools/generate',
18+
'/apps/admin/creating-account': '/apps/admin/authentication#creating-an-account',
19+
'/apps/admin/permissions': '/apps/admin/authentication#permissions',
1820
})
1921
2022
watch(

apps/admin/authentication.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Authentication
2+
3+
Lightbug accounts provide access to all Lightbug interfaces and connected devices.
4+
5+
6+
## Creating an Account
7+
8+
You can now create a Lightbug account directly through the admin portal.
9+
10+
To get started, open the admin portal, navigate to the [registration page](https://admin.lightbug.cloud/#/auth/register) and follow the account creation steps.
11+
12+
![Lightbug Admin portal account creation](https://i.imgur.com/7Fu00NW.png)
13+
14+
There are various password requirements to ensure account security, including minimum length, character variety, and a previous breach checker.
15+
16+
On successful account creation, you will be directed to the login page.
17+
18+
![Lightbug Admin portal account creation success](https://i.imgur.com/kYbF1jb.png)
19+
20+
### Sub Accounts
21+
22+
After creating your main account, you can add sub accounts to share device access with others from the admin portal.
23+
24+
For more details, see [adding new users to devices](/apps/admin/devices#add-new-user).
25+
26+
## Logging In
27+
28+
To log in to your Lightbug account, use the credentials you created during account setup.
29+
30+
First starting with the email address you registered with.
31+
32+
![Lightbug Admin portal login](https://i.imgur.com/xUAhQvi.png)
33+
34+
Once your email is entered, available login options will be displayed, most commonly password login.
35+
36+
![Lightbug Admin portal login options](https://i.imgur.com/s3yYBaN.png)
37+
38+
Select your preferred login method, and complete the login process.
39+
40+
### Password Login
41+
42+
If you choose password login, enter your password and click "Login".
43+
44+
![Lightbug Admin portal password login](https://i.imgur.com/gUHmrhg.png)
45+
46+
If you have forgotten your password, click the "[Forgot Password?](https://admin.lightbug.cloud/#/auth/request-password)" link to initiate a password reset.
47+
48+
## Permissions
49+
50+
All accounts can log in to the admin panel, however you will need to be granted permissions to access different features.
51+
52+
Different permissions will reveal different interfaces in the side bar, as well as content throughout the admin portal.
53+
54+
| Page | user | trackerAdmin |Description |
55+
| -- | -- | -- | -- |
56+
| [Devices](./devices.html) |||List all devices on the account|
57+
| [Configs](./configs.html) | ||Manage `config pages` that can be applied to devices|
58+
| [Users](./users.html) | ||Manage sub users of your account|

apps/admin/creating-account.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)