realm.properties - pc2ccs/pc2v9 GitHub Wiki

realm.properties is a file used to manage user accounts and passwords for the PC2V9 webserver. The webserver in turn is responsible for serving the CLICS JSON Event Feed. When the webserver is started it reads the realm.properties file to determine what accounts and passwords are defined for accessing (logging in to) the webserver.

Examples

Lines starting with "#" in the realm.properties file are comments and are ignored.

Sample realm.properties file defining just an admin account/password

 # This file is only used on the eventFeeder for the webServer
 #
 # Sample format looks like:
 # username: password,role1[,role2...]
 # Where roleX is either admin or public
 # public or admin is required to access /
 # admin also gives access to /starttime
 #
 # commented out examples:
 # admin: passw0rd,public,admin
 # public: pub1ic,public
 admin: admin,admin

Sample realm.properties file defining both admin and analyst roles (accounts)

 # This file is only used on the eventFeeder for the webServer
 #
 # Sample format looks like:
 # username: password,role1[,role2...]
 # Where roleN is either admin, public, analyst, blue and balloon
 # public or admin is required to access / (any web service)
 # admin also gives access to /starttime
 # analyst gives access to /submission_files
 #
 # commented out examples:
 # admin: passw0rd,public,admin
 # public: pub1ic,public
 admin: admin,admin
 analyst: analyst,analyst

File Format

Each non-comment line has the following form:

 username: password,role1[,role2...]

Roles

The following table describes the roles typically used in ICPC Contests, such as the ICPC World Finals.

Role	Description	special access
admin	full access	`/starttime`
analyst	Contest Analyst	`/submission_files`
balloon		Balloon Delivery Management
blue		blue network access
public	Access to web services