Skip to content

Iss 539 Server administration panel #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 28, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/.vuepress/sidebar/en.js
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ module.exports = {
'/server/upgrade/',
'/server/administer/',
'/server/troubleshoot/',
'/server/dashboard/',
'/server/plugin-mobile-app/'
]
},
Expand Down
3 changes: 2 additions & 1 deletion src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The ecosystem consist of various components:

## Setup GIS Project
- [QGIS Project Preparation](./gis/features/)
- [Searching for Values in Attribute Fields](./gis/search_data/)
- [Sorting and Search Setup](./gis/search_data/)
- [Background Maps](./gis/settingup_background_map/)
- [Map Themes](./gis/setup_themes/)
- [How to Set Photo Names Format](./gis/photo-names/)
Expand Down Expand Up @@ -108,6 +108,7 @@ The ecosystem consist of various components:
- [Upgrade](./server/upgrade/)
- [Administer](./server/administer/)
- [Troubleshoot Custom Servers](./server/troubleshoot/)
- [Administration Panel](./server/dashboard/)
- [Using Mergin Maps Mobile App and QGIS Plugin with a Custom Server](./server/plugin-mobile-app/)

## Migrate
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-accounts.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/server/dashboard/admin-panel-accounts.xcf
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/server/dashboard/admin-panel-overview.xcf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-projects.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/server/dashboard/admin-panel-projects.xcf
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/server/dashboard/admin-panel-settings.xcf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-workspaces.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/server/dashboard/admin-panel-workspaces.xcf
Binary file not shown.
Binary file added src/server/dashboard/dashboard-admin-panel.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/server/dashboard/dashboard-admin-panel.xcf
Binary file not shown.
78 changes: 78 additions & 0 deletions src/server/dashboard/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Administration Panel

[[toc]]

The server administration panel can be used to get an overview of the server usage, manage user access, projects and workspace.

It is accessible from the dashboard of your custom server. This option is available for super-users (server admins) or users who were [granted access](#accounts).

![Open Admin panel from the dashboard](./dashboard-admin-panel.jpg "Open Admin panel from the dashboard")

## Overview
The **Overview** provides a quick summary of the server: the number of editors, used storage, registered accounts, projects and workspaces.
![Server administration panel overview](./admin-panel-overview.jpg "Server administration panel overview")


## Accounts
The **Accounts** tab contains a list of all user accounts on the server.

Accounts can be sorted by usernames or emails. Use the search bar to find a specific account.

![Server administration panel overview](./admin-panel-accounts.jpg "Server administration panel overview")

### Manage account
To manage accounts and see their details:
1. Navigate to the **Accounts** tab of the admin panel.
2. Click on an account to display its details.

Here, you can:
- **Grant admin access** or **Revoke** it. Users with admin access have full access to all data on the server. They see all users and projects and can update or remove them.
- **Deactivate** or **Activate** account. Deactivated accounts can not use the server. If needed, they can be activated later.
- **Delete account** to permanently remove the user and all their data.

![Server administration panel overview](./admin-panel-account-details.jpg "Server administration panel overview")


### How to add a new user to a custom server
To add a new user to your server:
1. Navigate to the **Accounts** tab of the admin panel.
2. Click on the **Add user** button.
![Server administration panel Add user](./admin-panel-accounts-add-user.jpg "Server administration panel Add user")
3. Fill in the details: first name, email and password.
![Server administration panel Create new user](./admin-panel-accounts-create-new-user.jpg "Server administration panel Create new user")

An email invitation with login details will be sent to the email address provided.


## Projects
In the **Projects** tab, all projects in all workspaces on the server can be found.

Use the search bar to find a specific project using its name or the name of the workspace.
![Server administration panel Projects](./admin-panel-projects.jpg "Server administration panel Projects")

Click on a project to display its details. You can also **Download** the project or use the **Open in dashboard** button as a shortcut to the [dashboard](../../manage/dashboard/).

![Server administration panel Project details](./admin-panel-project-detail.jpg "Server administration panel Project details")


## Workspaces
The **Workspaces** tab provides the overview of all workspaces on the server.

Workspaces can be sorted by their name or description. Use the search bar to find a specific workspace.

![Server administration panel Workspaces](./admin-panel-workspaces.jpg "Server administration panel Workspaces")

Click on a workspace to display its details. Here, you can also:
- **Deactivate** or **Activate** the workspace
- **Delete workspace** to schedule the removal of a workspace from the server
- see the list of workspace members

![Server administration panel Workspace details](./admin-panel-workspace-details.jpg "Server administration panel Workspace details")

## Settings
In the **Settings** tab, you can:
- enable/disable the **Check for updates** option
- **Download** the server usage report with statistics for your server deployment

![Server administration panel Settings](./admin-panel-settings.jpg "Server administration panel Settings")

Loading