ovmm is a complement to the oTree Virtual Machine Image provided by
Felix Albrecht and Holger Gerhardt. Therefore, until now it is only tested on
this specific image. But, we do provide information (Requirements) on
how to create a similar image which can use
sudo or some commands might not work.
If you need more information on the commands, run
ovmm --version to display the version number.
ovmmfor the first time, run
sudo ovmm initialiseto configure your system.
The process leads you through the installation of required dependecies and creates necessary content files for
Enter administrator’s password.
Enter account information of the PostgreSQL superuser.
By default, the superuser for a PostgreSQL database is called
postgres. You also have to set a password for this account. This password can be new and will be set to the user by request.
After running the command, there is a folder called
/home/<user>/ovmm_sources/which contains a bash script
ovmm_conf. Perform the following checks:
- Check whether the login information for the PostgreSQL database is correctly set.
- Define the ranges of port numbers, e.g.
OVMM_DAPHNE_RANGE. Port ranges are stored in lists. Insert distinct values or use list comprehension for bigger ranges.
Next, go back to
ovmm_sourcesin your home folder. You should see a file called
nginx_template. Read the commentary to adjust the file to your network configuration.
This file will be reused every time a new user is created. The process will fill out the user specific values and place it under
/etc/nginx/sites-avalaible. Then, a symlink will link this file to
/etc/nginx/sites-enabled, so that Nginx takes care of it.
Forelast, try out one of the innocent lookup commands like
sudo ovmm count_useror
list_user. If they succeed, you have correctly set up
Last, set up a test account and verify whether everything is working including oTree by running one of the example experiments.
Command line options¶
Command line options are entered used with
sudo ovmm <command>
Since command expansion is implemented, the commands after the forward slash are also available.
- initialise / i
Adjust your system to the needs of
ovmm. It installs Ubuntu dependencies as well as configuration files for the Administrator.
- This command should be executed on first run in advance of any other command.
- An internet connection is needed
- add_user / a
- Add a new user to the configuration. Several prompts will ask you about user specific information. Please, fill out the forms in accordance with the provided examples.
- delete_user / d
- Delete a user from the configuration. Her account including her home folder is completely removed. Make sure you have a backup of all files in advance.
- backup_user / b
- Create a backup for a given user and save it in the
administrator’s home directory under
/home/<admin>/ovmm_sources/user_backups. Choose from one of three options,
home, whether you want to make a backup of the database or the home folder.
allis a shortcut to run a backup of both, database and home folder.
- count_user / c
- Return the number of existing accounts and the number of possible, additional accounts.
- list_user / l
- Give a list of user names of all currently installed users.
- route_port / r
- Change nginx default config to route port 80 (HTTP) and port 443 (HTTPS) to specific user account in addition to user specific port. Intended for running experiments where router settings prevent the access to non-standard web-ports like 780x.
- upgrade_statics / u
- Upgrades the statics in each existing user account with the versions in
ovmm/static/exp_env.7z. This is done by a simple extract and overwrite.
|--version||Returns the version number of |
- –help / -h
- Shows the help page. A more detailed version is available for each
sudo ovmm add_user --help / -h