Skip to content
This repository was archived by the owner on May 2, 2025. It is now read-only.

Commit 2ce1330

Browse files
mrhegemonmrhegemon
authored
Merge pull request #43 from EtherealEngine/AdminPanel-guide
[general] Write the `Admin Panel` guide
2 parents 2bae3f6 + fb967bb commit 2ce1330

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+331
-74
lines changed

‎docs/03_manual/01_general/03_adminPanel/00_intro.md

Lines changed: 9 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,9 @@
1-
# Admin Panel Guide
2-
_This page will become a section, and it will contain the Admin Panel Guide_
3-
## Dashboard
4-
### Usage Dashboard
5-
### Usage Time Series
6-
## Projects
7-
### Managing Projects
8-
### Project Table
9-
#### Name
10-
#### Version
11-
#### Commit SHA
12-
#### Commit Date
13-
#### Update
14-
#### GitHub Integration
15-
#### User Access
16-
#### Invalidate Cache
17-
#### View Project Files
18-
## Routes
19-
## Location
20-
### Create Location
21-
#### Name
22-
#### Max Users
23-
#### Scene
24-
#### Type
25-
#### Media Toggles
26-
#### Make Lobby
27-
#### Featured
28-
### Location Table
29-
## Instance
30-
### Patch InstanceServer
31-
### Instance Table
32-
### Instance Table Actions
33-
## Users
34-
### Create User
35-
#### Name
36-
#### Avatar
37-
#### Scopes
38-
##### Admin:Admin
39-
##### Benchmarking:read/write
40-
##### Bot:read/write
41-
##### contentPacks:read/write
42-
##### Editor:write
43-
##### globalAvatars:read/write
44-
##### Groups:read/write
45-
##### Instance:read/write
46-
##### Invite:read
47-
##### Location:read/write
48-
##### Party:read/write
49-
##### Projects:read/write
50-
##### realityPacks:read/write
51-
##### Recording:read/write
52-
##### Routes:read/write
53-
##### Scene:read/write
54-
##### Server:read/write
55-
##### Settings:read/write
56-
##### Static_resource:read/write
57-
##### User:read/write
58-
### User Table
59-
## Invites
60-
## Avatar
61-
### Create Avatar
62-
#### Avatar Name
63-
#### File Source
64-
#### Avatar Thumbnail
65-
### Avatar Table
66-
## Resources
67-
### Create Resource
68-
#### Name
69-
#### Project
70-
#### File Source
71-
## Benchmarking
72-
In work
73-
## Bots
74-
In work
1+
import DocCardList from '@theme/DocCardList'
2+
3+
# Admin Panel Overview
4+
The Ethereal Engine's `Admin Panel` is a graphical interface (GUI) tool for managing administration tasks of an Ethereal Engine deployment.
5+
6+
The Admin Panel can be accessed by navigating to the `/admin` route of the desired deployment.
7+
_eg: `https://localhost:3000/admin` when working with a local deployment_
8+
9+
<DocCardList />

‎docs/03_manual/01_general/03_adminPanel/01_dashboard.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Dashboard
2+
The Admin Panel Dashboard provides an overview of several performance indicators relevant to an Ethereal Engine's deployment.
3+
It gives a progress report for how a deployment is performing over a certain period of time based on data captured during the selected period.
4+
5+
![](./images/dashboard.png)
6+
7+
## Usage Dashboard
8+
The usage section shows a snapshot about the current usage of a deployment.
9+
<img width="1280" alt="image" src="https://github.com/EtherealEngine/etherealengine-docs/assets/92340542/f0282bf5-36ec-4220-85fa-636ba156689e" />
10+
11+
It shows the status of:
12+
- Active Parties
13+
- Active Locations
14+
- Active Scenes
15+
- Active Instances
16+
- Daily Users
17+
- Daily New Users
18+
19+
## Usage Time Series
20+
This section shows a time series of the information in the snapshot over a customizable period of time
21+
<img width="1207" alt="image" src="https://github.com/EtherealEngine/etherealengine-docs/assets/92340542/f623fa0f-72a0-49c8-82e1-51f8ddc7485b" />
22+
23+
The information is split between activity and user data.
24+
The time period is set to the last 30 days by default, but it can be changed to start and end at any arbitrary date.
25+
This information can be exported to an SVG or PNG image.

‎docs/03_manual/01_general/03_adminPanel/02_servers.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Servers
2+
The Servers page provides a list of all of the servers running in an Ethereal Engine's deployment.
3+
4+
![](./images/servers.png)
5+
_Note: The labels at the top of the page will filter servers by category when clicked._
6+
7+
For each server, it presents:
8+
- **Name**: The human-readable name given to the server for easier identification.
9+
- **Status**: The current state of the server _(Running, Succeeded, etc)_
10+
- **Type**: The type of server _(Media, World, Unassigned, etc)_
11+
- **Users**: How many users are currently active in the server.
12+
- **Restarts**: The moment in time when the server will next restart.
13+
- **Containers**: How many containers the server is using for its services.
14+
- **Age**: How long the server has been running.
15+
- **Instance**: Handle to the instance that this server is connected to.

‎docs/03_manual/01_general/03_adminPanel/03_projects.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Projects
2+
<!-- TODO: Confirm that the information given in this section is correct. -->
3+
The Projects page provides a tool to add new projects and list all existing projects of an Ethereal Engine's deployment.
4+
5+
![](./images/projects/list.png)
6+
7+
## Project Table
8+
- **Name**:
9+
Unique and identifiable name given to the project.
10+
11+
- **Version**:
12+
Version that is listed in the `package.json` file of the project.
13+
14+
- **Commit SHA**:
15+
`git` commit hash/ID that the project is tracking.
16+
17+
- **Commit Date**:
18+
Date when the tracked version of the project was last updated.
19+
20+
- **Update**:
21+
Orders the deployment to update the selected project to the latest commit of its repository.
22+
![](./images/projects/update.png)
23+
24+
- **Push to GitHub**:
25+
Uploads the project to a GitHub repository into the current user GitHub account.
26+
27+
- **GitHub Repo Link**:
28+
Opens a dialog to update the URL of the repository where the project is stored.
29+
![](./images/projects/repositoryLink.png)
30+
31+
- **User Access**:
32+
Opens a dialog to create links for giving access to the project to new users.
33+
34+
- **Invalidate Cache**:
35+
Order the deployment to invalidate the storage provider's cache of the selected project.
36+
37+
- **View Project Files**:
38+
Opens a dialog that provides a file explorer for managing the file-tree of the selected project.
39+
![](./images/projects/files.png)
40+
41+
- **Remove**:
42+
Orders the deployment to delete the project from its storage _(no undoing possible)_.
43+
44+
## Add project
45+
The Add Project button opens a dialog where new projects can be added to the deployment.
46+
- **Destination Repo**: . <!-- TODO: How do these work? -->
47+
- **Source Repo**: . <!-- TODO: How does these work? -->
48+
- **Copy from Destination Button**:
49+
Automatically copies the Destination URL into the Source URL field.
50+
- **Auto Update**:
51+
Enable/disable automatic updates for a project when the project's repository gets new commits.
52+
53+
![](./images/projects/add.png)
54+
55+
## Update/Rebuild the Engine
56+
The `Update Engine / Rebuild` action should be activated in the following situations:
57+
- Ordering to update the engine to its latest version available.
58+
- After making any changes to any of the projects stored in the deployment.
59+
- After changing between engine versions.
60+
_(either when reverting to an older version, or when going back to newer one)_
61+

‎docs/03_manual/01_general/03_adminPanel/04_routes.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Routes
2+
The Routes page provides a list of available routes for the deployment and projects.
3+
- **Project**:
4+
The project that provides the route.
5+
- **Route**:
6+
The path that has to be added to the deployment's root address to open the route.
7+
- **Active**:
8+
Controls whether the route is accessible or not.
9+
10+
![](./images/routes.png)

‎docs/03_manual/01_general/03_adminPanel/05_locations.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Locations
2+
The Locations page provides a tool to add new locations and list all existing locations of an Ethereal Engine's deployment.
3+
4+
![](./images/locations/list.png)
5+
## Location Table
6+
- **Name**:
7+
The human-readable name of the location.
8+
- **Scene**:
9+
The scene file that will be used for the location.
10+
- **Max Users Per Instance**:
11+
The maximum number of users that are allowed in the location before a new instance of that location is created.
12+
- **Type**:
13+
The access type of the location _(public, private, showroom)_
14+
- **Tags**:
15+
The tags that the location is marked with.
16+
- **Video Enabled**:
17+
_(Yes/No)_ Whether the location has the Video feature enabled or not.
18+
- **Action**:
19+
- **View**: Opens a dialog to manage the properties of the location.
20+
- **Delete**: Orders the deployment to delete the location from the list _(no undoing possible)_.
21+
22+
### View/Edit Properties
23+
The `Action: View` dialog provides a tool to edit all properties of the Location Table, plus:
24+
- **Audio Enabled**:
25+
Enable/disable the Audio feature for the location.
26+
- **Screen Sharing Enabled**:
27+
Enable/disable the Screen Sharing feature for the location.
28+
- **Face Streaming Enabled**:
29+
Enable/disable the Face Streaming feature for the location.
30+
- **Make Lobby**:
31+
Enable/disable the Lobby property for the location.
32+
- **Featured**:
33+
Enable/disable the Featured property for the location.
34+
35+
![](./images/locations/edit.png)
36+
37+
## Create Location
38+
Pressing the `Add Location` button will open a dialog to create a new location in the deployment.
39+
40+
![](./images/locations/create.png)
41+
_Note: Refer to the previous section ([Location Table](#location-table)) for a description of each of the properties._

‎docs/03_manual/01_general/03_adminPanel/06_instances.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Instances
2+
The Instances page provides a tool to view and patch existing instance servers running on the deployment.
3+
4+
![](./images/instances/list.png)
5+
6+
## Instance Table
7+
- **Instance ID**: Unique ID of the server that is running the Instance.
8+
- **IP Address**: IP Address and Port of the server running the Instance.
9+
- **Current Users**: Number of users currently active in the given location Instance server.
10+
- **Location**: Location that is active in the Instance server.
11+
- **Channel**: Communication channel active in the Instance server.
12+
- **Pod Name**: Name of the Kubernetes pod that is running the Instance server.
13+
- **Action**:
14+
- **Delete**: Orders the deployment to close the given Instance server.
15+
- **View**: Opens a dialog to manage the users of the Instance server.
16+
![](./images/instances/view.png)
17+
## Patch InstanceServer
18+
<!-- TODO: Properly explain what this is -->
19+
The Patch InstanceServer button opens a dialog that allows the deployment's instance servers to be patched.
20+
21+
![](./images/instances/patch.png)
22+

‎docs/03_manual/01_general/03_adminPanel/07_avatars.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Avatars
2+
The Avatars page provides a tool to view, upload and manage all of the Avatar files stored in the Ethereal Engine deployment.
3+
4+
![](./images/avatars/list.png)
5+
## Avatar Table
6+
- **Id**:
7+
Unique ID of the selected Avatar.
8+
- **Name**:
9+
Human-readable name of the selected Avatar.
10+
- **Owner**:
11+
User that owns the given Avatar.
12+
- **Public**:
13+
Whether the selected Avatar is publicly accessible by users other than the owner.
14+
- **Thumbnail**:
15+
Uploaded or auto-generated thumbnail image of the Avatar.
16+
- **Action**:
17+
- **Delete**: Orders the deployment to delete the target Avatar _(no undoing possible)_.
18+
- **View**: Opens a dialog to manage the properties of the target Avatar.
19+
Clicking the `Edit` button will make all Avatar properties editable until `Submit` is pressed.
20+
![](./images/avatars/view.png)
21+
## Create Avatar
22+
![](./images/avatars/create.png)

‎docs/03_manual/01_general/03_adminPanel/08_benchmarking.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Benchmarking
2+
<!-- ![](./images/benchmarking.png) -->
3+
<!-- TODO: Explain what this page is for -->

‎docs/03_manual/01_general/03_adminPanel/09_bots.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Bots
2+
<!-- TODO: Explain what this page is for -->
3+
The Bots page provides a tool to view and manage the bots of an Ethereal Engine deployment.
4+
## Create a new Bot
5+
- **Name**: .
6+
- **Description**: .
7+
- **Location**: .
8+
- **Instance**: .
9+
- **Command**: .
10+
- **Description**: .
11+
12+
![](./images/bots/create.png)
13+
![](./images/bots/list.png)

0 commit comments

Comments
 (0)