coopdevs.zulip_role

Zulip Role

This is an Ansible role to install Zulip using the Zulip installer.

The Zulip installer handles the installation of all necessary components and sets them up.

This Ansible role checks if there are any active Zulip realms before starting the installation or update. If it finds an active realm, it will automatically update your Zulip installation to ensure it works smoothly with the existing realms. This helps keep your Zulip environment stable and reduces disruptions for users.

Role Variables

development_enviroment: false
zulip_hostname: example.com
zulip_version: latest
zulip_installer: "https://download.zulip.com/server/zulip-server-{{ zulip_version }}.tar.gz"
cerbot_email: [email protected]
certbot_ssl: "{{ '--certbot' if not development_enviroment else '--self-signed-cert' }}"
installer_args: " --email={{ cerbot_email }} --hostname={{ zulip_hostname }} {{ certbot_ssl }}"
zulip_push_notifications: true
zulip_push_bouncer_url: "https://push.zulipchat.com"
zulip_enable_mail: true
zulip_smtp_server:
zulip_sendmail_user:
zulip_sendmail_password:
zulip_enable_giphy: true
zulip_giphy_api_key:

The certbot_ssl setting is automatically decided based on whether you are in a development environment. If you already have a valid SSL certificate, you should set it to an empty string. Valid options are '', --certbot, or --self-signed. You need to provide cerbot_email to request a certificate with certbot.

The zulip_push_notifications setting allows you to enable or disable push notifications. To use them, you must provide the URL for your push bouncer in zulip_push_bouncer_url, which defaults to the Zulip push bouncer URL (https://push.zulipchat.com).

The zulip_enable_mail setting lets you enable or disable email auto-configuration. If you want this feature, you need to fill in zulip_smtp_server, zulip_sendmail_user, and zulip_sendmail_password.

The zulip_enable_giphy setting allows or prevents Giphy integration. It is set to true by default. To use this feature, you need to provide your Giphy API key in zulip_giphy_api_key.