diff --git a/README.md b/README.md index 8dc743f..1b4653c 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,21 @@ Requirements 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. +| Variable | Description | Default | +| ---------- | ------------- | | +| docker_user | The user who is going to manage/run the Docker Compose services | deploy | +| jitsi_enable_letsencrypt | Jitsi will take care of Let's Encrypt certificates | 0 | +| *jitsi_letsencrypt_email* | E-Mail adress used for requesting certificates | Not set | +| jitsi_exposed_http_port | Exposed container port for HTTP | 8000 | +| jitsi_exposed_https_port | Exposed container port for HTTPS | 8443 | +| jitsi_public_url | The public URL under which Jitsi Meet can be accessed | http://localhost | +| jitsi_timezone | | Europe/Amsterdam | +| jitsi_virtual_host | The virtual host that is e.g. used by Traefik, usually part of the public url | localhost | 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. + Example Playbook ---------------- @@ -38,4 +47,4 @@ MIT Author Information ------------------ -https://jotbe.io/ +See [jotbe.io](https://jotbe.io/)