UGC Guard Docs

English

Deutsch

English

Deutsch

Appearance

Organizations ​

INFO

To edit settings of your organization, you need to be an admin.

The base entity of UGC Guards are organizations. They group all Modules, users and other settings into one big entity. A user can be member of many organizations.

Setup of an organization ​

INFO

Self-hosted UGC Guard entities can deactive the creation of new organizations

Login to your UGC Guard account.

If you are being redirected to an existing organization, press Organizations in the sidebar.

  1. Press create new organization
  2. Fill out the form by entering:
  • A valid name
  • A concise description
  • A valid support e-mail. This e-mail will be used to send automatic mails on new reports.
  1. Save and select the new organization in the list.

Setup AI services. ​

Open the dashboard and select Settings.

  1. Choose the tab AI Settings.
  2. Activate the AI feature for this organization (if not already done).
  3. Choose, which AI services you want to enable for this organization.

WARNING

AI usage is billed per token either by UGC Guard or by the AI provider.

INFO

To use AI services in the self-hosted variant of UGC Guard, you need to set them up correctly in your .env file. See the configuration tutorial on how to do that.

User management ​

Open the dashboard and select Users.

INFO

There are four different roles a user can be in:

  • invited
  • reviewer
  • member
  • admin

Invite users ​

  1. Select Invite
  2. Enter the email of a user that is known to this UGC Guard instance.
  3. If the user exists, they see the new organization on their organization list.

Revoke invitation ​

  1. Press the yellow alert next to the user in the users table.
  2. Confirm the alert to revoke the invitation.

Accept/reject invitation ​

Only the invited user can accept the invitation.

  1. Login as the invited user
  2. Go to Organizations if not already redirected there.
  3. Select the invited organization.

To accept:

  1. Simply confirm the alert.

To deny:

  1. Deny the first alert.
  2. Accept the second alert to reject the invitation.

Change membership of an user ​

Per default, all new members join as a reviewer, once they accepted their invitation.

INFO

We are working on this behaviour. If you have feedback, please let us know.

  1. Search for the user in the users table.
  2. Press edit.
  3. Choose their new role.
  4. Confirm.

INFO

Users might have to login again to see their role updated in the UI. The backend processes role changes immediately.

Remove user from organization ​

  1. Search for the user in the users table
  2. Select remove action
  3. Confirm the alert

Payment ​

INFO

This section is only relevant for the hosted variant of UGC Guard.

More infos to follow.