Skip to content

Commit

Permalink
docs: add details about admin credentials
Browse files Browse the repository at this point in the history
  • Loading branch information
authcompanion committed Oct 5, 2023
1 parent 97dd115 commit b91bf3e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
10 changes: 3 additions & 7 deletions documentation/guide/administer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,12 @@

## Administering the system

The Admin Dashboard is a tool that allows an administrator or a web application owner to manage the users of their web application.

It provides a range of functions that help administrators to create, edit, and delete user accounts stored by AuthCompanion.
The Admin Dashboard is a tool that allows an administrator or a web application owner to manage the users of their web application. It provides a range of functions that help administrators to create, edit, and delete user accounts stored by AuthCompanion.

On Server startup, the Admin Dashboard is available at the `/admin/` endpoint - `http://localhost:3002/v1/admin/login` (or the port you have configured in your `.env` file).

An admin user can log in to the Admin Dashboard using the credentials that are auto-created when the AuthCompanion server starts up.

You can find the username and password within the application files at the default path described in `.env` file `ADMIN_KEY_PATH=./adminkey`. Only one admin user will be registered in the system at a time.

When you log in, please make sure change the password for the admin user to a secure password by editing the account details for the admin user with email `admin@localhost` in the Admin Dashboard.
You can find the email and password within the application files at the default path described in `.env` file `ADMIN_KEY_PATH=./adminkey` - it's also printed to terminal on the AuthC sever's first startup. Only one admin user will be registered in the system at this time.

The Admin Dashboard is a Vue.js (vue3) application that is served from the AuthCompanion server. Deployed as is a Single Page Application (SPA), it uses the AuthCompanion [Admin API](/reference/adminapi.md) to manage users.
Under the hood, the Admin Dashboard is a Vue.js (vue3) application that is served from the AuthCompanion server. Deployed as is a Single Page Application (SPA), it uses the AuthCompanion [Admin API](/reference/adminapi.md) to manage users.
1 change: 1 addition & 0 deletions documentation/reference/adminapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Description: Trades the admin credentials for an admin access token used to acce
"data": {
"type": "users",
"attributes": {
"email": "admin@localhost",
"password": "9ae5a568ad70f6c3ee886d72baf1e5fcec3be630"
}
}
Expand Down

0 comments on commit b91bf3e

Please sign in to comment.