Playbook variables¶
This is a reference of available Ansible Playbook variables for websauna.ansible playbook. See deployment documentation for more information.
Required¶
These variables are required to be filled in for every websauna.ansible playbook. You usually declare them in vars section in your playbook.yml file.
backup¶
Do we install an automatic Duplicity backup script. If òn` you need have credentials for Duplicity backup scripts in the secrets INI file.
Default value not set.
cloudflare¶
Do we use cloudflare.com proxy at the front of the side. If yes then Nginx is made to accept HTTP/HTTPS connections from Cloudflare servers only.
Default value not set.
git_repository¶
What is the Git repository URL for deployed Websauna application. E.g. git@bitbucket.org:miohtama/example.git
Default value not set.
ini_secrets_file¶
A local path to a file where production-secrets.ini file is. This file contains API tokens like Facebook API keys, session randomization seeds and such. Example: ../myapp/conf/production-secrets.ini
Default value not set.
letsenrypt¶
Do we automatically fecth and install a TSL certificate for Nginx HTTPS traffic from letsencrypt.com. If on you must supply a valid server_name and have DNS configured.
Default value not set.
new_relic¶
Do we use NewRelic.com monitoring for the server. If on you need to supply New Relic API key.
Default value not set.
notify_email¶
Where do we send email about server logs, failures, cron jobs. Use your sysadmin email address.
Default value not set.
package_name¶
The Python package name which we are going to deploy as Websauna application on the server. Usually like my.app, one generated by Websauna application cookiecutter.
Default value not set.
package_path¶
Path, inside the package, to the top level module. Usually like my/app, one generated by Websauna application cookiecutter.
Default value not set.
server_email¶
What From: email addresses server uses for outgoing email notifications. Example: no-reply@example.com
Default value not set.
server_email_domain¶
What this the suffix domain used by Postfix when generating emails from this server. Example: example.com
Default value not set.
site_id¶
site_id is referred in folders and files generated by the playbook. Usually same as the package name.
Default value not set.
site_mode¶
Site mode is either staging or production. This is used e.g. when generating database names, so that different environments get their own database.
Default value not set.
smtp¶
Do we configure outbound email through mandrill.com service. See Outbound email deployment documentation for more information. If not set you need to configure outbound email for Postfix yourself.
Default value not set.
Optional¶
Variables defined here are optional for running Webasuna playbook. If you do not fill them Playbook doesn’t take any action or generate anything. Usually these variables are required only if you turn on some of the optional services is required variables.
htpasswd_password¶
Nginx htpasswd password to protect the site. Keep this in Ansible vault.
Default value not set.
htpasswd_user¶
Nginx htpasswd username to protect the site. Keep this in Ansible vault.
Default value not set.
nginx_ssl_certificate_path¶
Fill this variable if ssl is on. Server-side path to a TLS certificate file for Nginx. Usually .pem. Note that certificate and certificate key can be in same .pem file.
Default value not set.
nginx_ssl_certificate_path_key¶
Fill this variable if ssl is on. Server-side path to a TLS certificate key file for Nginx. Usually .pem. Note that certificate and certificate key can be in same .pem file.
Default value not set.
smtp_username¶
SMTP service username for outbound email. Your sign up email like mikko@example.com. Keep this in Ansible vault.
Default value not set.
Default¶
These are default Ansible variables consumed by various templates in Websauna deployment. They are generated based on core information you give it. You can override any of these variables by including another variable file after default.yml in your playbook using``include_vars`` Ansible command after default.yml is included in your playbook.
db_sqlalchemy_url¶
No description provided at the moment.
Default value:
postgresql://localhost/{{ db_name }}
dependencies¶
No description provided at the moment.
Default value:
- git
- supervisor
- build-essential
- libfreetype6-dev
- libncurses5-dev
- libxml2-dev
- libxslt1-dev
- libjpeg-dev
- libpng12-dev
- fail2ban
- gettext
- duplicity
- python-boto
- python-virtualenv
- libpq-dev
- libffi-dev
- libzmq3-dev
- ntp
- postgresql-client-common
- postgresql-client-9.3
deploy_location¶
No description provided at the moment.
Default value:
/srv/pyramid/{{ package_name }}
local_key_file¶
A certificate file key on local environment to copy over to the server. Usually like certificate.pem. Note that certificate and certificate key can be in same .pem file. Leave empty if using Let’s Encrypt.
Default value not set.
nginx_access_log¶
No description provided at the moment.
Default value:
/var/log/nginx/{{ site_id }}.access.log
nginx_error_log¶
No description provided at the moment.
Default value:
/var/log/nginx/{{ site_id }}.error.log
postgresql_databases¶
No description provided at the moment.
Default value:
- ordereddict([('name', '{{\xa0db_name }}'), ('hstore', 'yes'), ('uuid_ossp', 'yes'), ('gis', 'yes')])
postgresql_user_privileges¶
No description provided at the moment.
Default value:
- ordereddict([('name', '{{\xa0db_user }}'), ('db', '{{\xa0db_name }}'), ('priv', 'ALL'), ('role_attr_flags', 'CREATEDB')])
postgresql_users¶
No description provided at the moment.
Default value:
- ordereddict([('name', '{{\xa0db_user }}'), ('pass', '{{\xa0db_password }}'), ('encrypted', 'no')])
pypi_index_url¶
No description provided at the moment.
Default value:
https://pypi.python.org/simple
pyramid_notebook_notebook_folder¶
No description provided at the moment.
Default value:
{{ deploy_location}}/notebooks
python_interpreter¶
Name of the Python interpreter for creating the Websauna application virtual environment.
Default value:
python3.5
uwsgi_config_target¶
No description provided at the moment.
Default value:
{{ websauna_conf_folder }}/uwsgi.ini
websauna_conf_folder¶
No description provided at the moment.
Default value:
{{ deploy_location }}/{{ package_path }}/conf
websauna_config_file¶
No description provided at the moment.
Default value:
{{ websauna_conf_folder }}/generated.ini
websauna_config_includes¶
No description provided at the moment.
Default value:
resource://{{ package_name }}/conf/{{ site_mode }}.ini resource://websauna/conf/production.ini resource://{{ package_name }}/conf/base.ini resource://websauna/conf/base.ini
websauna_secrets_ini_file¶
No description provided at the moment.
Default value:
{{ websauna_conf_folder }}/generated-secrets.ini
websauna_wsgi_file¶
No description provided at the moment.
Default value:
{{ websauna_conf_folder }}/websauna.wsgi