Administrator Panel

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

    Creating an Administrator Account

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

    cd ~/greenlight
    

    Using Greenlight Image

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

    docker run --rm -v $(pwd)/db/production:/usr/src/app/db/production --env-file .env bigbluebutton/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:

    cd ~/greenlight
    docker run --rm -v $(pwd)/db/production:/usr/src/app/db/production --env-file .env bigbluebutton/greenlight:v2 bundle exec rake admin:create["name","email","password"]
    

    Note: All of the above arguments are optional and if you don’t specify an argument it will be replaced with a default value.

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

    Greenlight Administrator Account Create

    Using Custom Image

    If you checked out the Greenlight code and followed the Customize instructions, then you don’t need to include the docker run... at the start of the command.

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

    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:

    bundle exec rake admin:create["name","email","password"]
    

    Note: All of the above arguments are optional and if you don’t specify an argument it will be replaced with a default value.

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

    Greenlight Administrator Account Create

    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

    Managing Users

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

    The search box can be used to filter based on Name, Username and Authenticator.

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

    Greenlight Administrator Manage Users

    Promoting Accounts

    To promote an account from a User to an Administrator, select Promote to Admin from the Account Dropdown.

    Demoting Accounts

    To demote an account from an Administrator to a User, select Demote to User from the Account Dropdown.

    Deleting Accounts

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

    While this removes the account from Greenlight the user will still be able to sign up to Greenlight using the same email in the future.

    Banning Accounts

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

    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, default language, and profile picture for the given account.

    Site Branding

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

    Greenlight Administrator Manage Users

    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.

    Change the Primary Colour

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

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

    See also