Setup

Installing Jophiel

First, follow the main Judgels setup instructions if you haven’t. This means that you should have installed Jophiel by running

judgels pull jophiel

and should have modified the common configuration keys in conf/application.conf and conf/db.conf.

Configuring Jophiel

This section will cover the specific configuration keys for Jophiel.

play.mailer.{host, port, ssl, user, password}
SMTP credentials configuration for sending user account related emails.
jophiel.idToken.key.private
An RSA private key for generating ID token required for OpenID Connect protocol. You can generate one using ssh-keygen command. Make sure to select RSA as the algorithm.
jophiel.client.{labels, targets}
The list of public Judgels Play applications you want to inform to the users on the welcome page. This is useful in order to users that have just logged in not to get lost in SSO. Put the list of URLs in targets, and the corresponding link labels in labels.
noreply.{name, email}
The name and email of “noreply” user for sending user account related emails.
aws.avatar.s3.use
Whether to use AWS as the storage for user avatars. If set to true, then the rest of the aws.avatar.* keys below should be modified accordingly.
aws.avatar.s3.{bucket.name, bucket.regionId}
The bucket name and bucket region ID for the S3 storage.
aws.avatar.cloudFront.baseUrl
The base URL for CloudFront for the S3 storage. You must set up CloudFront.
aws.key.use
Whether a pair of keys must be used for connecting to S3. For example, if the EC2 that hosts Jophiel has been associated to a role that has permission for connecting to S3, then this value should be false.
aws.key.{access, secret}
If a pair of keys must be used, then these are the access and secret keys, respectively.
recaptcha.registration.use
Whether to use reCAPTCHA for the registration form.
recaptcha.registration.key.{site, secret}
If reCAPTCHA is used, then these are the site and secret keys, respectively.

Adding initial admin

Jophiel has been successfully installed and configuring. Now, we need to have a user with admin role.

  1. Open Jophiel. You will be presented with a login screen. Choose Register.
  2. Register a user to be assigned as admin.
  3. Validate the user by following the validation email. If you don’t have a valid SMTP server setup, you can do the validation manually by setting the emailVerified column to 1 in the corresponding row in the jophiel_user_email table.
  4. Manually assign this user as admin, by setting the roles column to user,admin in the corresponding row in the jophiel_user table.
  5. Log in to Jophiel. Verify that you can view the Users menu on the left.