Commit a49cd2be authored by Torsten N. Fit's avatar Torsten N. Fit
Browse files

Adding info to README.md

parent a07fe6cf
Role Name
au_otree
=========
A brief description of the role goes here.
Role to setup oTree dev/prod environment on Ubuntu server. (VM, Cloud instance etc).
Requirements
------------
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
The actual oTree code for dev/prod should be in a git repository "otree_repo", that can be cloned.
If you are using GitLab, but want to keep repo private, then consider using a deploy-token:
https://docs.gitlab.com/ee/user/project/deploy_tokens/#git-clone-a-repository
Role Variables
--------------
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
otree_user: "ot"
otree_prod_port: 8000
otree_dev_port: 8100
otree_fqdn: "otree.local"
otree_repo: "https://gitlab.au.dk/otree/otree_example_apps.git"
otree_admin_password='my_otree_admin_pw'
Dependencies
------------
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
Role works stand-alone.
Example Playbook
----------------
......@@ -24,8 +31,16 @@ Example Playbook
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
tasks:
- name: Include the oTree role
include_role:
name: au_otree
vars:
allow_world_readable_tmpfiles: true
ansible_python_interpreter: /usr/bin/python3.8
otree_fqdn: "fqdn or hostname"
otree_repo: "https://gitlab+deploy-token-36XXXXXXX@gitlab.au.dk/otree/otree_polsci.git"
otree_admin_password: "my_otree_admin_pw"
License
-------
......@@ -35,4 +50,4 @@ BSD
Author Information
------------------
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
tnielsen@au.dk
......@@ -42,7 +42,7 @@
var: otree_uid
verbosity: 1
- name: Include tasks for setting up network interface
- name: Include tasks for setting up oTree incl. files and folders
ansible.builtin.include_tasks:
file: 'otree_setup.yml'
apply:
......
......@@ -3,6 +3,6 @@ VIRTUAL_ENV="/home/{{ otree_user }}/otree_root/venv_otree"
#LOCAL_PATH="/home/{{ otree_user }}/.local/bin"
#PATH="$VIRTUAL_ENV:$LOCAL_PATH:$PATH"
PATH=/home/{{ otree_user }}/.local/bin:{{ base_dir }}/venv_otree/bin:$PATH
OTREE_ADMIN_PASSWORD='dirt_poor_prod'
OTREE_ADMIN_PASSWORD={{ otree_admin_password }}
OTREE_PRODUCTION=1
OTREE_AUTH_LEVEL=DEMO
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment