Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
65 changes: 65 additions & 0 deletions src/server/audit-log-events/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
description: List of events that are tracked in Mergin Maps audit logs.
---

# Audit Log Events

[[toc]]

Here is a complete list of events tracked in [Audit logs](../dashboard/#audit-logs).

## User audit events
- `user.login.succeeded` - Successful login
- `user.login.failed` - Failed login attempt
- `user.password.changed` - User changes their password
- `user.password.reset_requested` - User requests password reset
- `user.password.reset_completed` - User finalised password reset
- `user.password.reset_failed` - Password reset failed due to invalid reset or other means
- `user.created` - User account created
- `user.updated` - User profile updated
- `user.marked_for_deletion` - User account scheduled for deletion
- `user.deactivated` - User account set inactive
- `user.restored` - User account restored by admin (reactivated account or cancelled scheduled deletion)
- `user.deleted` - User account permanently deleted
- `user.locked` - User account locked after too many failed logins
- `user.unlocked` - User account unlocked
- `user.admin_panel_access.changed` - Admin user account changed (user became server admin or lost access to the admin panel)

## Project audit events
- `project.created` - Project created
- `project.updated` - Project settings changed
- `project.transfer_request.initiated` - Project transfer request sent
- `project.transfer_request.received` - Project transfer request received
- `project.transfer_request.completed` - Project transfer completed (by the original workspace)
- `project.transfer_request.accepted` - Project transfer accepted (by the new workspace)
- `project.transfer_request.canceled` - Project transfer cancelled (by the original workspace)
- `project.transfer_request.rejected` - Project transfer rejected (by the new workspace)
- `project.marked_for_deletion` - Project scheduled for deletion
- `project.restored` - Project scheduled for deletion restored
- `project.deleted` - Project permanently deleted
- `project.member.added` - User added to a project
- `project.member.updated` - Project member role changed
- `project.member.deleted` - User removed from a project
- `project.access_request.initiated` - User sent a request to access a project
- `project.access_request.accepted` - Project access request accepted
- `project.access_request.canceled` - Project access request cancelled
- `project.version.created` - New project version created
- `project.map_sharing.updated` - Webmap link enabled or disabled
- `project.map_sharing.link_rotated` - Webmap link regenerated
- `project.ogc_api.access_updated` - OGC API link updated (created, regenerated, removed)
- `project.ogc_api.link_rotated` - OGC API link regenerated

## Workspace audit events
- `workspace.created` - Workspace created
- `workspace.updated` - Workspace settings changed
- `workspace.marked_for_deletion` - Workspace scheduled for deletion
- `workspace.deactivated` - Workspace deactivated
- `workspace.restored` - Workspace reactivated
- `workspace.deleted` - Workspace permanently deleted
- `workspace.member.added` - User added to workspace
- `workspace.member.updated` - Workspace member role changed
- `workspace.member.deleted` - User removed from workspace
- `workspace.invitation.created` - Workspace invitation sent
- `workspace.invitation.updated` - Workspace invitation resent
- `workspace.invitation.accepted` - Workspace invitation accepted
- `workspace.invitation.canceled` - Workspace invitation cancelled or rejected
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 modified src/server/dashboard/admin-panel-account-details.xcf
Binary file not shown.
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 modified src/server/dashboard/admin-panel-accounts-add-user.xcf
Binary file not shown.
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 modified src/server/dashboard/admin-panel-accounts-create-new-user.xcf
Binary file not shown.
Binary file removed src/server/dashboard/admin-panel-accounts.jpg
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-accounts.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/server/dashboard/admin-panel-accounts.xcf
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-audit-logs.webp
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-audit-logs.xcf
Binary file not shown.
Binary file removed src/server/dashboard/admin-panel-overview.jpg
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-overview.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 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 removed src/server/dashboard/admin-panel-project-detail.jpg
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 modified src/server/dashboard/admin-panel-project-detail.xcf
Binary file not shown.
Binary file removed src/server/dashboard/admin-panel-projects.jpg
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-projects.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/server/dashboard/admin-panel-projects.xcf
Binary file not shown.
Binary file removed src/server/dashboard/admin-panel-settings.jpg
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-settings.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/server/dashboard/admin-panel-settings.xcf
Binary file not shown.
Binary file added src/server/dashboard/admin-panel-sso.webp
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-sso.xcf
Binary file not shown.
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 modified src/server/dashboard/admin-panel-workspace-details.xcf
Binary file not shown.
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 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 removed src/server/dashboard/admin-panel-workspaces.jpg
Diff not rendered.
Binary file added src/server/dashboard/admin-panel-workspaces.webp
Binary file modified src/server/dashboard/admin-panel-workspaces.xcf
Binary file not shown.
Binary file removed src/server/dashboard/dashboard-admin-panel.jpg
Diff not rendered.
Binary file added src/server/dashboard/dashboard-admin-panel.webp
57 changes: 42 additions & 15 deletions src/server/dashboard/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ The server administration panel can be used to get an overview of the server usa

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")
![Open Admin panel from the dashboard](./dashboard-admin-panel.webp "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")
The **Overview** provides a quick summary of the server: the number of users, used storage, registered accounts, projects and workspaces.
![Server administration panel overview](./admin-panel-overview.webp "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")
![Server administration panel overview](./admin-panel-accounts.webp "Server administration panel overview")

### Manage account
To manage accounts and see their details:
Expand All @@ -34,16 +34,17 @@ Here, you can:
- **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")
![Server administration panel overview](./admin-panel-account-details.webp "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")
![Server administration panel Add user](./admin-panel-accounts-add-user.webp "Server administration panel Add user")

3. Fill in the details: email and password.
![Server administration panel Create new user](./admin-panel-accounts-create-new-user.webp "Server administration panel Create new user")

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

Expand All @@ -52,43 +53,69 @@ An email invitation with login details will be sent to the email address provide
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")
![Server administration panel Projects](./admin-panel-projects.webp "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")
![Server administration panel Project details](./admin-panel-project-detail.webp "Server administration panel Project details")

In the respective tabs, you can find:
- **Files** - the list of all files associated with the project
- **History** - an overview of available project versions that can be also downloaded to your computer
- **Settings** - project settings and the option to *permanently* delete the project

![Server administration panel delete project](./admin-panel-project-delete.webp "Server administration panel delete project")

## Workspaces
<ServerType type="EE" />
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")
![Server administration panel Workspaces](./admin-panel-workspaces.webp "Server administration panel Workspaces")

Click on a workspace to display its details. Here, you can also:
- **Update limits** of the workspace by setting a custom storage and contributors limit for the workspace
- **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")
![Server administration panel Workspace details](./admin-panel-workspace-details.webp "Server administration panel Workspace details")

### How to create a new workspace

1. Navigate to the **Workspaces** tab and click on the **Create workspace** button
![Server administration panel - create new workspace](./admin-panel-workspaces-create-workspace.jpg "Server administration panel - create new workspace")
![Server administration panel - create new workspace](./admin-panel-workspaces-create-workspace.webp "Server administration panel - create new workspace")

2. Fill in the name of the workspace and **Save changes**.
![Server administration panel - create new workspace](./admin-panel-workspaces-create-workspace-form.jpg "Server administration panel - create new workspace")
![Server administration panel - create new workspace](./admin-panel-workspaces-create-workspace-form.webp "Server administration panel - create new workspace")

The new workspace is created.

## Audit logs
<ServerType type="EE" />

The **Audit Logs** contains records of activity across users, projects and workspaces, such as project updates, user management, permission changes, or login attempts. Read-only actions, such as browsing or downloading, are not logged.

Logs cannot be edited or deleted.

You can filter the logs by event type, actor email, user, workspace, project and date range of the event. Click on a log to display more details about the event.

![Server administration panel Audit logs](./admin-panel-audit-logs.webp "Server administration panel Audit logs")

::: tip Audit logs events
For a complete list of tracked events, see [Audit Log Events](../audit-log-events).
:::

## 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")
![Server administration panel Settings](./admin-panel-settings.webp "Server administration panel Settings")

## SSO Administration
<ServerType type="EE" />
Click on the **SSO Administration** to configure [Single Sign-On Deployment](../sso-deployment/) for your <EnterprisePlatformName />.

![Server administration panel SSO](./admin-panel-sso.webp "Server administration panel SSO")
2 changes: 1 addition & 1 deletion src/server/sso-deployment/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ You can now set up your first SSO (SAML or OIDC) connection in the Ory Polis adm

Follow the steps below to create a new connection:

* Go to <MainPlatformName /> admin panel and log in.
* Go to [<MainPlatformName /> admin panel](../dashboard/) and log in.
* In the left menu click **SSO Administration**.
* Log in to the Ory Polis admin panel using credentials from the `NEXTAUTH_ADMIN_CREDENTIALS` variable.
* Navigate to the **Enterprise SSO** tab and click **New Connection**.
Expand Down
Loading