Moab Access Portal

Appendix A: Configuration Parameters

These parameters are maintained in the map.properties file in a simple <NAME>=<VALUE> format. By default, Moab Access Portal® looks for this file in the /etc/map/ directory, but one can specify an alternate location by passing in the Java system property CONFIG-FILE=<ABSOLUTE PATH>.

  • Name
  • Format
  • Default Value
  • Description
  • Example
  • ALLOW-SYSTEM-VIEW
  • <TRUE | FALSE> FALSE specifies whether users have the option of viewing all other users' jobs, reservations, etc. ALLOW-SYSTEM-VIEW=TRUE
  • ATTRIBUTES-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the attributes icons (job submit) ATTRIBUTES-ICON=custom/attrselect.gif
  • BROWSE-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the file browse icon (job submit) BROWSE-ICON=custom/filebrowse.gif
  • CALENDAR-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the calednar icon (job submit) CALENDAR-ICON=custom/calendar.gif
  • CANCEL-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the cancellation icon (reservation list) CANCEL-ICON=custom/cancel.gif
  • CFGDIR
  • <ABS PATH> (include / at end!) /etc/mapdir/ an absolute path defining the directory where the portal's configuration file (map.properties) is located and where other config files will be stored CFGDIR=/etc/mapdir/
  • CLIENT-LOGO
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as a logo in the upper-right corner of the portal's header CLIENT-LOGO=custom/computer_club.gif
  • CLOCK-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the clock icon (job submit) CLOCK-ICON=custom/clock.gif
  • DEFAULT-REFRESH-INTERVAL
  • <SECONDS> 120 seconds specifies the default refresh or poll interval (in seconds) at which Access Portal will contact the cluster interactive node and refresh its information cache. DEFAULT-REFRESH-INTERVAL=60
  • DEMO
  • <TRUE | FALSE> [NONE] specifies whether Access Portal should run in demonstration mode or not. DEMO=TRUE
  • FAVICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a .ico file to be used as the browser FAVICON/SHORTCUT IMAGE FAVICON=custom/favicon.ico
  • FILE-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the file icon FILE-ICON=custom/file.gif
  • FOLDER-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the folder icon FOLDER-ICON=custom/folder.gif
  • HELP-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the "Help" navigation button. If this parameter is not specified (commented out) the help system will be disabled. At this time this is the default and recommended configuration. HELP-ICON=custom/help.gif
  • LOGDIR
  • <ABS PATH> /tmp
  • deprecated - an absolute path defining the directory where the portal's log configuration file (log4j.properties) is located
  • LOGDIR=/tmp
  • LOGOUT-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the "Logout" navigation button LOGOUT-ICON=custom/logout.gif
  • MAXFILESIZE
  • <SIZE> 3145728 bytes the maximum size (in bytes) of a script/executable file that can be uploaded MAXFILESIZE=2048
  • MOAB-COMMANDS-PATH
  • <ABS PATH> user's PATH env variable on head node the absolute path (on the cluter's head node) where Moab commands are located (i.e. showq, mjobctl, mdiag, etc.) INCLUDE TRAILING '/' ! MOAB-COMMANDS-PATH=/usr/local/moab/bin/
  • PORTAL-LOGO
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as a logo for the main header PORTAL-LOGO=custom/acme-computing.gif
  • PORTAL-TITLE
  • <HTML/TEXT> [NONE] HTML enriched text that will appear as the title in the main header - underneath the portal logo PORTAL-TITLE=<b>ACME</b> High Preformance Computing
  • REFRESH-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the "Refresh" navigation button REFRESH-ICON=custom/refresh.gif
  • SHOW-WORKLOAD-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the "Show All/Only My" icon (used in many areas) SHOW-WORKLOAD-ICON=custom/showall.gif
  • SSH-KEY-AUTH
  • <TRUE | FALSE> FALSE specifies whether Access Portal uses SSH keys (instead of passwords) for authentication with the cluster's interactive node SSH-KEY-AUTH=TRUE
  • SSH-HOMEDIR-ACCESS
  • <ABS PATH> [NONE] if
  • SSH-KEY-AUTH is set to TRUE this specifies the directory where users' home subdirectories are located. For example, on most default Linux® systems these subdirectories are found in /home/. MAP will use this directory to find the users' SSH private keys it needs to login a user. It does this by looking for the file: ${SSH-HOMEDIR-ACCESS}/<USER>/.ssh/<USER>_id, where <USER> is the valid username.
  • SSH-HOMEDIR-ACCESS=/home
  • THEME
  • <REL PATH> default.css a relative path from the portal's include directory locating a .css stylesheet which is used to define the portal's "look-and-feel." (See the include/default.css file for details on configurable attributes.) THEME=custom/showall.gif
  • UPLOADDIR
  • <ABS PATH> /tmp an absolute path defining the directory where uploaded scripts/executables will be temporarily stored before being transfered to the cluster for staging UPLOADDIR=/tmp/uploads
  • UPLOAD-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the upload icon (submit job) UPLOAD-ICON=custom/upload.gif
  • VIEW-JOB-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the view job icon (view jobs) VIEW-JOB-ICON=custom/viewjobs.gif
  • WRITE-SCRIPT-ICON
  • <REL PATH> [NONE] a relative path from the portal's images directory locating a graphic file to be used as the write script icon (submit job) WRITE-SCRIPT-ICON=custom/writescript.gif
  • X11-FREE
  • <TRUE | FALSE> TRUE specifies whether X11 (or any GUI) dependant Java infrastructure will be loaded in order to support GUI features. (No features at this time in Access Portal require this to be set to FALSE.) On servers, especially headless ones, we recommend TRUE in every case. X11-FREE=TRUE

    Moab Access Portal