Admin

    Creating Accounts

    The following examples assume you have Greenlight installed in the ~/greenlight directory. Before running the commands, change into the ~/greenlight directory.

    cd ~/greenlight

    Creating a User Account

    To create an User account with specified values, in the Greenlight directory, run the following command:

    docker exec greenlight-v2 bundle exec rake user:create["name","email","password","user"]

    Once the command has finished it will print the account’s email and password.

    Creating an Administrator Account

    To create an Administrator account with the default values, in the Greenlight directory, run the following command:

    docker exec greenlight-v2 bundle exec rake admin:create

    If you would like to configure the name, email, or password of the Administrator account, replace the previous command with this:

    docker exec greenlight-v2 bundle exec rake user:create["name","email","password","admin"]

    Once the command has finished it will print the account’s email and password.

    Administrator Panel

    Greenlight has an administrator account that gives you the ability to manage users on the server.

    Accessing the Administrator Panel

    Once you are logged in as an Administrator, you will notice a new item in the Account Dropdown titled Organization.

    Greenlight Administrator Access

    Greenlight Administrator Panel

    Managing Users

    Through the Manage Users tab, Administrators are able to view and search for all user accounts that have been created.

    Administrators are also able to edit each account by clicking on the vertical ellipsis.

    Greenlight Administrator Manage Users

    Tabs

    To switch between tabs, click on the tab that you want to switch to.

    Greenlight Administrator Manage Users Tabs

    Tab Description
    Active Users that are able to access the application using their account
    Pending Users that are awaiting approval to join the application
    Banned Users that have been denied or banned
    Deleted Users whose account has been deleted by an administrator

    Search and Filter

    The search box can be used to filter based on the Name, Username, Authenticator or Creation Date of any user.

    Greenlight Administrator Manage Users Search

    To filter by the Role, click on any of the Role buttons under the Role Column. This will filter the list to show only the users with the clicked Role.

    Greenlight Administrator Manage Users Filter

    Deleting Accounts

    To delete an account, select Delete from the Account Dropdown.

    Once an account gets deleted, the user will be moved to the Deleted tab.

    Greenlight Administrator Manage Users Delete

    From the Deleted tab, an administrator can then either recover the user’s account and their associated rooms, or permanently delete the user. If a user is permanently deleted, it will NOT be possible to recover the account.

    NOTE: Permanently deleted users can resignup using the same email address of the account that was deleted.

    Banning Accounts

    To ban an account, select Ban User from the account dropdown.

    Once an account gets banned, the user will be moved to the Banned tab.

    This will remove the account from Greenlight and will also prevent the user from signing up using the same email to Greenlight in the future.

    Editing Accounts

    To edit an account, select Edit for the specified user. This will open the edit user view.

    From the edit user view, Administrators are able to edit the name, email, roles, default language, and profile picture for the given account.

    Editing Roles

    To edit the role for an account, select Edit for the specified user. This will open the edit user view.

    Greenlight Administrator Edit User Roles

    From the edit user view, Administrators are able to assign and remove roles for the given account. To remove a role click the x beside the role. To add a role select the role from the roles dropdown beneath the role tags.

    NOTE: Administrators are only able to add or removes roles which have a lower priority than their highest priority role.

    NOTE: While a user may be assigned multiple roles only the role with the highest priority will be used for determining a user’s permissions

    Resetting User Passwords

    If the user has forgotten their password, the Administrator can send them an email that they can use to reset their password.

    To reset a user’s password, select Edit for the specified user. This will open the edit user view. From there, the Administrator just needs to click the Reset user password button and an email will be sent out to the user with the required instructions.

    Server Recordings

    Through the Server Recordings tab, Administrators are able to view all of the recordings that exist on their BigBlueButton server.

    NOTE: Due to limitations on the BigBlueButton API, if your server has many rooms or recordings, the page may not load due to the request timing out.

    Greenlight Administrator Server Recs

    The search box can be used to filter based on the Name, Length, Users, Recording Owner, Visibility or Format of any user.

    Greenlight Administrator Server Recs Search

    Sort

    It is possible to sort recordings by metrics such as Name, User Number, and Length of Recording.

    This can be done by clicking on the headers of the table (cycles through ascending, descending, and no particular order):

    Greenlight Administrator Server Recs Sort

    Site Settings

    Administrators are able to customize Greenlight through the Site Settings Tab.

    Greenlight Administrator Site Settings

    Change the Branding Image

    To change Greenlight’s Branding Image which is displayed in the top left corner, replace the default image with a URL of your image and click Change Image.

    Greenlight Administrator Branding Image

    Change the Primary Colour

    To change Greenlight’s Primary Colour open the colour palette and select a new Primary Colour.

    Changing the “Regular” Primary Colour will also automatically calculate the Lighten and Darken versions of the color.

    If you would like to change the Lighten or Darken version, they can be individually changed to any colour possible.

    The Primary Colour is the colour that Greenlight uses as a basis for the styling. This includes buttons, links, icons, etc.

    Greenlight Administrator Primary Colour

    Registration Methods

    Through the Site Settings, you can configure the Registration Method for Greenlight.

    Greenlight Administrator Registration Method

    Open Registration

    Open Registration allows any user to sign up and sign in to Greenlight.

    Join by Invitation

    Join by Invitation disables the open sign up. Users will only be able to sign up if they have received an invitation from an Administrator.

    To use Join by Invitation, ALLOW_MAIL_NOTIFICATIONS must be set to true in the .env file.

    To invite a user, click in the Invite User button that is beside the Search Bar.

    Greenlight Administrator Invite Button

    To send an email to multiple users, enter their emails seperated by a comma. If you would like to invite only 1 user, enter their email with no commas.

    The user(s) will receive an email with a button that will link them to the sign up page.

    Greenlight Administrator Invite Modal

    Approve/Decline

    Approve/Decline allows anyone to sign up for Greenlight, but that user must be Approved inorder for them to access the features available through Greenlight.

    When a user signs up, they will be set to a Pending state. The Administrator will be able be able to view all Pending users in the Pending tab in the Manage Users table.

    If ALLOW_MAIL_NOTIFICATIONS is set to true in the .env file, then all Administrators will receive an email when a user signs up.

    Greenlight Administrator Pending Users

    Users can either be Approved or Declined by clicking on the Account Dropdown.

    If ALLOW_MAIL_NOTIFICATIONS is set to true in the .env file, the user will receive an email informing them that their account has been approved.

    Greenlight Administrator Approve

    If a user sign up is declined, they will be set to the Banned state. A banned user can not sign in or access any of the features in Greenlight.

    Greenlight Administrator Declined

    Require Authentication to Join

    By default, users that are not signed in can join any Room that has been started by the Room Owner if they are given the invitation link. This can be disabled, meaning that only users that are signed in will be allowed to join a Room.

    Greenlight Administrator Room Authentication

    Recording Default Visibility

    Sets the default visibility of room recordings.

    Public: everyone can view it if they have the room link.
    Unlisted: only users who have the recording link can view it.

    Greenlight Administrator Default Recording

    Number of Rooms per User

    By default, users are allowed to create and manage as many rooms as they like. Using this setting, an Administrator can limit the number of rooms that the user can create. If the user is already above the limit and the setting is changed, the user will not be able to start any sessions for the rooms that are above the limit.

    To allow the users to create as many rooms as they would like, select the option furthest to the right (15+).

    Greenlight Administrator Room Limit

    User Roles

    Through the Roles tab Administrators are able to edit the roles for their site.

    Greenlight Administrator Edit Roles

    A role’s position in the roles list denotes its priority. The higher up on the list the higher the priority of the role.

    Creating a New Role

    To create a new role click on the Create a new role button. This will open the create role pop-up where Administrators can specficy the new role’s name.

    Greenlight Administrator New Roles

    The new role will automatically be created with the second lowest priority only higher than the user role.

    Changing a Role’s Priority

    To change an existing role’s priority drag the role to the position you desire in the list of roles.

    Note: Administrators are only able to change the priority of roles which have a lower priority than their own.

    Note: The Admin role must always be the highest priority role and the user role must always be the lowest priority role.

    Editing an Existing Role

    To edit the permissions for a role select the role from the list of roles.

    Greenlight Administrator Edit Role Permissions

    Once the administrator has selected the role they are able to update the name for the role as well as the colour associated with the role.

    Administrators are also able to update the permissions for the role. The following section describes what each permission does

    Permission Description
    Can create rooms This determines whether or not users with this role are able to create their own Greenlight rooms.
    Send an email to users when they are assigned this role This determines whether or not to send an email to users when they are promoted to this role
    Send an email to users when they are removed from this role This determines whether or not to send an email to users when they are removed from this role
    Allow users with this role to edit site settings This allows users to access the Server Recordings and Site Settings tabs as if they were administrators
    Allow users with this role to edit other roles This allows users to access the Roles tab as if they were administrators
    Allow users with this role to manage other users This allows users to access the Manage Users tab as if they were administrators

    Note: Administrators are unable to change the name for the user role or any of the permissions associated with the Admin role. Administrators are also only able to edit the permissions for roles with a lower priority than their own role.

    Deleting a Role

    To delete a role click the “Delete the role button”. For the role to be successfully deleted no users may be assigned to the role. The admin and user roles also can’t be deleted.

    See also