ansible-immunity22

Ansible role that installs the Immunity Server Application.

Tested on Debian (Bullseye), Ubuntu (20/22 LTS).

NOTE: it is highly suggested to use this procedure on clean virtual machines or linux containers.

Recommended ansible version: 2.12.

Demo

Try the Immunity Demo to get a quick overview of what Immunity can do for you.

Help Immunity

Like Immunity? Find out how to help us!

• Help us to grow our community
• How to contribute to Immunity

Architecture

For more information, see Immunity Architecture.

System Requirements

The following specifications will run a new, empty instance of Immunity. Please ensure you account for the amount of disk space your use case will require, e.g. allocate enough space for users to upload floor plan images.

Hardware requirements (Recommended)

• 2 CPUs
• 2 GB Memory
• Disk space - depends on the projected size of your database and uploaded photo images

Keep in mind that increasing the number of celery workers will require more memory and CPU. You will need to increase the amount of celery workers as the number of devices you manage grows.

For more information about how to increase concurrency, look for the variables which end with _concurrency or _autoscale in the Role Variables section.

Software

Generally a fresh installation of one of the supported operating systems is sufficient; no pre-configuration required. The Ansible Playbook will install and configure all dependencies and leave you with a running Immunity installation.

Tips: Ensure the hostname of your target machine matches what is in your Ansible configuration file. Also, please ensure that Ansible can access your target machine by SSH, be it either with a key or password. For more information see the Ansible Getting Started Documentation.

Supported Operating Systems

See the section "OS Platforms" on the ansible-galaxy page of ansible-immunity22.

Usage (tutorial)

If you don't know how to use ansible, don't panic, this procedure will guide you towards a fully working basic immunity22 installation.

If you already know how to use ansible, you can skip this tutorial.

First of all you need to understand two key concepts:

• for "production server" we mean a server (not a laptop or a desktop computer!) with public ipv4 / ipv6 which is used to host immunity22
• for "local machine" we mean the host from which you launch ansible, eg: your own laptop

Ansible is a configuration management tool that works by entering production servers via SSH, so you need to install it and configure it on the machine where you launch the deployment and this machine must be able to SSH into the production server.

Ansible will be run on your local machine and from there it will connect to the production server to install immunity22.

If you are trying to install Immunity2 on your laptop or desktop pc just for testing purposes, please read Install Immunity2 for testing in a VirtualBox VM.

Install ansible

Install ansible (recommended version 2.12) on your local machine (not the production server!) if you haven't done already.

To install ansible we suggest you follow the official ansible installation guide. It is recommended to install ansible through a virtual environment to avoid dependency issues.

Please ensure that you have the correct version of Jinja installed in your Python environment:

pip install Jinja2>=2.11

After having installed ansible, you need to install git (example for linux debian/ubuntu systems):

sudo apt-get install git

Install this role

For the sake of simplicity, the easiest thing is to install this role on your local machine via ansible-galaxy (which was installed when installing ansible), therefore run:

ansible-galaxy install edge-servers.immunity22

Ensure that you have the community.general and ansible.posix collections installed and up to date:

ansible-galaxy collection install "community.general:>=3.6.0"
ansible-galaxy collection install "ansible.posix"

Choose a working directory

Choose a working directory on your local machine where to put the configuration of immunity22.

This will be useful when you will need to upgrade immunity22.

Eg:

mkdir ~/immunity22-ansible-playbook
cd ~/immunity22-ansible-playbook

Putting this working directory under version control is also a very good idea.

Create inventory file

The inventory file is where group of servers are defined. In our simple case we can get away with defining just one group in which we will put just one server.

Create a new file called hosts in your local machine's working directory (the directory just created in the previous step), with the following contents:

[immunity22]
immunity22.mydomain.com

Substitute immunity22.mydomain.com with your production server's hostname - DO NOT REPLACE immunity22.mydomain.com WITH AN IP ADDRESS, otherwise email sending through postfix will break, causing 500 internal server errors on some operations.

Create playbook file

Create a new playbook file playbook.yml on your local machine with the following contents:

- hosts: immunity22
  become: "{{ become | default('yes') }}"
  roles:
    - edge-servers.immunity22
  vars:
    immunity22_default_from_email: "[email protected]"

The line become: "{{ become | default('yes') }}" means ansible will use the sudo program to run each command. You may remove this line if you don't need it (eg: if you are root user on the production server).

You may replace immunity22 on the hosts field with your production server's hostname if you desire.

Substitute [email protected] with what you deem most appropriate as default sender for emails sent by Immunity 2.

Run the playbook

Now is time to deploy immunity22 to the production server.

Run the playbook from your local machine with:

ansible-playbook -i hosts playbook.yml -u <user> -k --become -K

Substitute <user> with your production server's username.

The -k argument will need the sshpass program.

You can remove -k, --become and -K if your public SSH key is installed on the server.

Tips:

• If you have an error like Authentication or permission failure then try to use root user ansible-playbook -i hosts playbook.yml -u root -k
• If you have an error about adding the host's fingerprint to the known_hosts file, you can simply connect to the host via SSH and answer yes when prompted; then you can run ansible-playbook again.

When the playbook is done running, if you got no errors you can login at:

https://immunity22.mydomain.com/admin
username: admin
password: admin

Substitute immunity22.mydomain.com with your production server's hostname.

Now proceed with the following steps:

1. change the password (and the username if you like) of the superuser as soon as possible
2. update the name field of the default Site object to accurately display site name in email notifications
3. edit the information of the default organization
4. in the default organization you just updated, note down the automatically generated shared secret option, you will need it to use the auto-registration feature of immunity-config
5. this Ansible role creates a default template to update authorized_keys on networking devices using the default access credentials. The role will either use an existing SSH key pair or create a new one if no SSH key pair exists on the host machine.

Now you are ready to start configuring your network! If you need help you can ask questions on one of the official Immunity Support Channels.

Install ansible-immunity22 for development

If you need to modify the logic of this ansible role and you need to test your changes here we explain how to do it.

First of all, create the directory where you want to place the repositories of the ansible roles and create directory roles.

    mkdir -p ~/immunity-dev/roles
    cd ~/immunity-dev/roles

Clone ansible-immunity22 and Stouts.postfix as follows:

    git clone https://github.com/edge-servers/ansible-immunity22.git edge-servers.immunity22
    git clone https://github.com/Stouts/Stouts.postfix
    git clone https://github.com/edge-servers/ansible-im-influxdb edge-servers.influxdb

Now, go to the parent directory & create hosts file and playbook.yml:

    cd ../
    touch hosts
    touch playbook.yml

From here on you can follow the instructions available at the following sections:

• Create inventory file
• Create playbook file
• Run the playbook

Note: Please remember to install ansible.

All done!

How to run tests

If you want to contribute to ansible-immunity22 you should run tests in your development environment to ensure your changes are not breaking anything.

To do that, proceed with the following steps:

Step 1: Clone ansible-immunity22

Clone repository by:

git clone https://github.com/<your_fork>/ansible-immunity22.git edge-servers.immunity22
cd edge-servers.immunity22

Step 2: Install docker

If you haven't installed docker yet, you need to install it (example for linux debian/ubuntu systems):

sudo apt-get install docker.io

Step 3: Install molecule and dependences

pip install molecule[docker] molecule-plugins yamllint ansible-lint docker

Step 4: Download docker images

docker pull geerlingguy/docker-ubuntu2204-ansible:latest
docker pull geerlingguy/docker-ubuntu2004-ansible:latest
docker pull geerlingguy/docker-debian11-ansible:latest

Step 5: Run molecule test

molecule test -s local

If you don't get any error message it means that the tests ran successfully without errors.

ProTip: Use molecule test --destroy=never to speed up subsequent test runs.

Install Immunity2 for testing in a VirtualBox VM

If you want to try out Immunity 2 in your own development environment, the safest way is to use a VirtualBox Virtual Machine (from here on VM).

Using Vagrant

Since August 2018 there's a new fast and easy way to install Immunity 2 for testing purposes leveraging Vagrant, a popular open source tool for building and maintaining portable virtual software development environments.

To use this new way, clone the repository vagrant-immunity22, it contains the instructions (in the README.md) and the vagrant configuration to perform the automatic installation.

Alternatively, you can read on to learn how to install VirtualBox and run ansible-immunity22 manually, this is useful if you need to test advanced customisations of Immunity.

Installing Debian 9 on VirtualBox

Install VirtualBox and create a new Virtual Machine running Debian 11. A step-by-step guide is available here, however we need to change a few things to get ansible working.

VM configuration

Proceed with the installation as shown in the guide linked above, and come back here when you see this screen:

We're only running this as a server, so you can uncheck Debian desktop environment. Make sure SSH server and standard system utilities are checked.

Next, add a Host-only Network Adapter and assign an IP address to the VM.

• On the Main VirtualBox page, Go to File > Host Network Manager

• Click the + icon to create a new adapter

• Set the IPv4 address to 192.168.56.1 and the IPv4 Network Mask to 255.255.255.0. You may need to select Configure Adapter Manually to do this. The IPv6 settings can be ignored

• Shut off your VM

• In your VM settings, in the Network section, click Adapter 2 and Enable this Adapter

• Select Host-only adapter and the name of the adapter you created

• Boot up your VM, run su, and type in your superuser password

• Run ls /sys/class/net and take note of the output

• Run nano /etc/network/interfaces and add the following at the end of the file:

    auto enp0s8
    iface enp0s8 inet static
        address 192.168.56.2
        netmask 255.255.255.0
        network 192.168.56.0
        broadcast 192.168.56.255
  

  Replace enp0s8 with the network interface not present in the file but is shown when running ls /sys/class/net

• Save the file with CtrlO then Enter, and exit with CtrlX

• Restart the machine by running reboot

Make sure you can access your VM via ssh:

ssh 192.168.56.2

Back to your local machine

Proceed with these steps in your local machine, not the VM.

Step 1: Install ansible

Step 2: Install the Immunity2 role for Ansible

Step 3: Set up a working directory

Step 4: Create the hosts file

Create an ansible inventory file named hosts in your working directory (i.e. not in the VM) with the following contents:

[immunity22]
192.168.56.2

Step 5: Create the ansible playbook

In the same directory where you created the host file, create an empty file named playbook.yml which contains the following:

- hosts: immunity22
  roles:
    - edge-servers.immunity22
  # the following line is needed only when an IP address is used as the inventory hostname
  vars:
      postfix_myhostname: localhost

Step 6: Run the playbook

ansible-playbook -i hosts playbook.yml -b -k -K --become-method=su

When the playbook ran successfully, you can log in at:

https://192.168.56.2/admin
username: admin
password: admin

Enabling the Monitoring module

The Monitoring module is enabled by default, it can be disabled by setting immunity22_monitoring to false.

Enabling the Network Topology module

To enable the Network Topology module you need to set immunity22_network_topology to true in your playbook.yml file. Here's a short summary of how to do this:

Step 1: Install ansible

Step 2: Install this role

Step 3: Create inventory file

Step 4: Create a playbook file with following contents:

- hosts: immunity22
  become: "{{ become | default('yes') }}"
  roles:
    - edge-servers.immunity22
  vars:
    immunity22_network_topology: true

Step 5: Run the playbook

When the playbook is done running, if you got no errors you can login at:

https://immunity22.mydomain.com/admin
username: admin
password: admin

Enabling the Firmware Upgrader module

Note: It is encouraged that you read the quick-start guide of immunity-firmware-upgrader before going ahead.

To enable the Firmware Upgrader module you need to set immunity22_firmware_upgrader to true in your playbook.yml file. Here's a short summary of how to do this:

Step 1: Install ansible

Step 2: Install this role

Step 3: Create inventory file

Step 4: Create a playbook file with following contents:

- hosts: immunity22
  become: "{{ become | default('yes') }}"
  roles:
    - edge-servers.immunity22
  vars:
    immunity22_firmware_upgrader: true

Step 5: Run the playbook

When the playbook is done running, if you got no errors you can login at:

https://immunity22.mydomain.com/admin
username: admin
password: admin

Note: You can configure immunity-firmware-upgrader specific settings using the immunity22_extra_django_settings or immunity22_extra_django_settings_instructions.

E.g:

- hosts: immunity22
  become: "{{ become | default('yes') }}"
  roles:
    - edge-servers.immunity22
  vars:
    immunity22_firmware_upgrader: true
    immunity22_extra_django_settings_instructions:
      - |
        IMMUNITY_CUSTOM_OPENWRT_IMAGES = (
            ('my-custom-image-squashfs-sysupgrade.bin', {
                'label': 'My Custom Image',
                'boards': ('MyCustomImage',)
            }),
        )

Enabling the RADIUS module

To enable the RADIUS module you need to set immunity22_radius to true in your playbook.yml file. Here's a short summary of how to do this:

Step 1: Install ansible

Step 2: Install this role

Step 3: Create inventory file

Step 4: Create a playbook file with following contents:

- hosts: immunity22
  become: "{{ become | default('yes') }}"
  roles:
    - edge-servers.immunity22
  vars:
    immunity22_radius: true
    immunity22_freeradius_install: true
    # set to false when you don't want to register immunity-radius
    # API endpoints.
    immunity22_radius_urls: true

Note: immunity22_freeradius_install option provides a basic configuration of freeradius for immunity, it sets up the radius user token mechanism if you want to use another mechanism or manage your freeradius separately, please disable this option by setting it to false.

Step 5: Run the playbook

When the playbook is done running, if you got no errors you can login at:

https://immunity22.mydomain.com/admin
username: admin
password: admin

Note: for more information regarding radius configuration options, look for the word "radius" in the Role variables section of this document.

Configuring CORS Headers

While integrating Immunity with external services, you can run into issues related to CORS (Cross-Origin Resource Sharing). This role allows users to configure the CORS headers with the help of django-cors-headers package. Here's a short summary of how to do this:

Step 1: Install ansible

Step 2: Install this role

Step 3: Create inventory file

Step 4: Create a playbook file with following contents:

- hosts: immunity22
  become: "{{ become | default('yes') }}"
  roles:
    - edge-servers.immunity22
  vars:
    # Cross-Origin Resource Sharing (CORS) settings
    immunity22_django_cors:
      enabled: true
      allowed_origins_list:
        - https://frontend.immunity.org
        - https://logs.immunity.org

Note: to learn about the supported fields of the immunity22_django_cors variable, look for the word "immunity22_django_cors" in the Role variables section of this document.

Step 5: Run the playbook

When the playbook is done running, if you got no errors you can login at:

https://immunity22.mydomain.com/admin
username: admin
password: admin

The ansible-immunity22 only provides abstraction (variables) for handful of settings available in django-cors-headers module. Use the immunity22_extra_django_settings_instructions or immunity22_extra_django_settings variable to configure additional setting of django-cors-headers as shown in the following example:

- hosts: immunity22
  become: "{{ become | default('yes') }}"
  roles:
    - edge-servers.immunity22
  vars:
    immunity22_django_cors:
      enabled: true
      allowed_origins_list:
        - https://frontend.immunity.org
        - https://logs.immunity.org
      replace_https_referer: true
    # Configuring additional settings for django-cors-headers
    immunity22_extra_django_settings_instructions:
      - |
        CORS_ALLOW_CREDENTIALS = True
        CORS_ALLOW_ALL_ORIGINS = True

Deploying custom static content

For deploying custom static content (HTML files, etc.) add all the static content in files/ow2_static directory. The files inside files/ow2_static will be uploaded to a directory named static_custom in immunity22_path.

This is helpful for customizing Immunity's theme.

E.g., if you added a custom CSS file in files/ow2_static/css/custom.css, the file location to use in IMMUNITY_ADMIN_THEME_LINKS setting will be css/custom.css.

Deploying the upcoming release of Immunity

The following steps will help you set up and install the new version of Immunity which is not released yet, but ships new features and fixes.

Create a directory for organizing your playbook, roles and collections. In this example, immunity-dev is used. Create roles and collections directories in ~/immunity-dev.

mkdir -p ~/immunity-dev/roles
mkdir -p ~/immunity-dev/collections

Change directory to ~/immunity-dev/ in terminal and create configuration and requirement files for Ansible.

cd ~/immunity-dev/
touch ansible.cfg
touch requirements.yml

Setup roles_path and collections_paths variables in ansible.cfg as follows:

[defaults]
roles_path=~/immunity-dev/roles
collections_paths=~/immunity-dev/collections

Ensure your requirements.yml contains following content:

---
roles:
  - src: https://github.com/edge-servers/ansible-immunity22.git
    version: master
    name: edge-servers.immunity22-dev
collections:
  - name: community.general
    version: ">=3.6.0"

Install requirements from the requirements.yml as follows

ansible-galaxy install -r requirements.yml

Now, create hosts file and playbook.yml:

touch hosts
touch playbook.yml

Follow instructions in "Create inventory file" section to configure hosts file.

You can reference the example playbook below (tested on Debian 11) for installing a fully-featured version of Immunity.

- hosts: immunity22
  become: "{{ become | default('yes') }}"
  roles:
    - edge-servers.immunity22-dev
  vars:
    immunity22_network_topology: true
    immunity22_firmware_upgrader: true
    immunity22_radius: true
    immunity22_monitoring: true # monitoring is enabled by default

Read "Role Variables" section to learn about available configuration variables.

Follow instructions in "Run the playbook" section to run above playbook.

Troubleshooting

Immunity 2 is deployed using uWSGI, it also uses daphne fo WebSockets and celery as task queue.

All this services are run by supervisor.

sudo service supervisor start|stop|status

You can view each individual process run by supervisor with the next command.

More info at Running supervisorctl

sudo supervisorctl status

nginx is in front of uWSGI. You can control it with next command

service nginx status start|stop|status

Immunity 2 is installed in /opt/immunity22 (unless you changed the immunity22_path variable in the ansible playbook configuration), these are some useful directories to look for when experiencing issues.

Location	Description
/opt/immunity22	The Immunity 2 root dir.
/opt/immunity22/log	Log files
/opt/immunity22/env	Python virtual env
/opt/immunity22/db.sqlite3	Immunity 2 sqlite database

All processes are running as www-data user.

If you need to copy or edit files, you can switch to www-data user with the commands

sudo su www-data -s /bin/bash
cd /opt/immunity22
source env/bin/activate

SSL certificate gotchas

When you access the admin website you will get an SSL certificate warning because the playbook creates a self-signed (untrusted) SSL certificate. You can get rid of the warning by installing your own trusted certificate and set the immunity22_ssl_cert and immunity22_ssl_key variables accordingly or by following the instructions explained in the section "Automatic SSL certificate".

If you keep the untrusted certificate, you will also need to disable SSL verification on devices using immunity-config by setting verify_ssl to 0, although I advice against using this kind of setup in a production environment.

Automatic SSL certificate

This section explains how to automatically install and renew a valid SSL certificate signed by letsencrypt.

The first thing you have to do is to setup a valid domain for your immunity22 instance, this means your inventory file (hosts) should look like the following:

[immunity22]
immunity22.yourdomain.com

You must be able to add a DNS record for immunity22.yourdomain.com, you cannot use an ip address in place of immunity22.yourdomain.com.

Once your domain is set up and the DNS record is propagated, proceed by installing the ansible role geerlingguy.certbot:

ansible-galaxy install geerlingguy.certbot

Then proceed to edit your playbook.yml so that it will look similar to the following example:

- hosts: immunity22
  become: "{{ become | default('yes') }}"
  roles:
    - geerlingguy.certbot
    - edge-servers.immunity22
  vars:
    # SSL certificates
    immunity22_ssl_cert: "/etc/letsencrypt/live/{{ inventory_hostname }}/fullchain.pem"
    immunity22_ssl_key: "/etc/letsencrypt/live/{{ inventory_hostname }}/privkey.pem"

    # certbot configuration
    certbot_auto_renew_minute: "20"
    certbot_auto_renew_hour: "5"
    certbot_create_if_missing: true
    certbot_auto_renew_user: "<privileged-users-to-renew-certs>"
    certbot_certs:
      - email: "<paste-your-email>"
        domains:
          - "{{ inventory_hostname }}"
  pre_tasks:
    - name: Update APT package cache
      apt:
        update_cache: true
      changed_when: false
      retries: 5
      delay: 10
      register: result
      until: result is success

Read the documentation of geerlingguy.certbot to learn more about configuration of certbot role.

Once you have set up all the variables correctly, run the playbook again.

Upgrading immunity22

It's highly recommended to back up your current instance before upgrading.

Update this ansible-role via ansible-galaxy:

ansible-galaxy install --force edge-servers.immunity22

Run ansible-playbook again from your local machine:

ansible-playbook -i hosts playbook.yml

You may also run the playbook automatically periodically or when a new release of Immunity2, for example, by setting up a continuous integration system.

Role variables

This role has many variables values that can be changed to best suit your needs.

Below are listed all the variables you can customize (you may also want to take a look at the default values of these variables).

- hosts: yourhost
  roles:
  # you can add other roles here
    - edge-servers.immunity22
  vars:
    # Enable the modules you want to use
    immunity22_network_topology: false
    immunity22_firmware_upgrader: false
    immunity22_monitoring: true
    # you may replace the values of these variables with any value or URL
    # supported by pip (the python package installer)
    # use these to install forks, branches or development versions
    # WARNING: only do this if you know what you are doing; disruption
    # of service is very likely to occur if these variables are changed
    # without careful analysis and testing
    immunity22_controller_version: "immunity-controller~=1.0.0"
    immunity22_network_topology_version: "immunity-network-topology~=1.0.0"
    immunity22_firmware_upgrader_version: "immunity-firmware-upgrader~=1.0.0"
    immunity22_monitoring_version: "immunity-monitoring~=1.0.0"
    immunity22_radius_version: "immunity-radius~=1.0.0"
    immunity22_django_version: "django~=3.2.13"
    # Setting this to true will enable subnet division feature of
    # immunity-controller. Refer immunity-controller documentation
    # for more information. https://github.com/edge-servers/immunity-controller#subnet-division-app
    # By default, it is set to false.
    immunity22_controller_subnet_division: true
    # when immunity22_radius_urls is set to false, the radius module
    # is setup but it's urls are not added, which means API and social
    # views cannot be used, this is helpful if you have an external
    # radius instance.
    immunity22_radius_urls: "{{ immunity22_radius }}"
    immunity22_path: /opt/immunity22
    # It is recommended that you change the value of this variable if you intend to use
    # Immunity2 in production, as a misconfiguration may result in emails not being sent
    immunity22_default_from_email: "[email protected]"
    # Email backend used by Django for sending emails. By default, the role
    # uses "CeleryEmailBackend" from django-celery-email.
    # (https://github.com/pmclanahan/django-celery-email)
    immunity22_email_backend: "djcelery_email.backends.CeleryEmailBackend"
    # Email timeout in seconds used by Django for blocking operations
    # like connection attempts. For more info read the Django documentation,
    # https://docs.djangoproject.com/en/3.2/ref/settings/#email-timeout.
    # Defaults to 10 seconds.
    immunity22_email_timeout: 5
    # edit database settings only if you are not using sqlite
    # eg, for deploying with PostgreSQL (recommended for production usage)
    # you will need the PostGIS spatial extension, find more info at:
    # https://docs.djangoproject.com/en/4.1/ref/contrib/gis/tutorial/
    immunity22_database:
        engine: django.contrib.gis.db.backends.postgis
        name: "{{ DB_NAME }}"
        user: "{{ DB_USER }}"
        host: "{{ DB_HOST }}"
        password: "{{ DB_PASSWORD }}"
        port: 5432
    # SPATIALITE_LIBRARY_PATH django setting
    # The role will attempt determining the right mod-spatialite path automatically
    # But you can use this variable to customize the path or fix future arising issues
    immunity22_spatialite_path: "mod_spatialite.so"
    # customize other django settings:
    immunity22_language_code: en-gb
    immunity22_time_zone: UTC
    # immunity-controller context
    immunity22_context: {}
    # additional allowed hosts
    immunity22_allowed_hosts:
        - myadditionalhost.immunity.org
    # geographic map settings
    immunity22_leaflet_config:
        DEFAULT_CENTER: [42.06775, 12.62011]
        DEFAULT_ZOOM: 6
    # enable/disable geocoding check
    immunity22_geocoding_check: true
    # specify path to a valid SSL certificate and key
    # (a self-signed SSL cert will be generated if omitted)
    immunity22_ssl_cert: "/etc/nginx/ssl/server.crt"
    immunity22_ssl_key: "/etc/nginx/ssl/server.key"
    # customize the self-signed SSL certificate info if needed
    immunity22_ssl_country: "US"
    immunity22_ssl_state: "California"
    immunity22_ssl_locality: "San Francisco"
    immunity22_ssl_organization: "IT dep."
    # the following setting controls which ip address range
    # is allowed to access the controller via unencrypted HTTP
    # (this feature is disabled by default)
    immunity22_http_allowed_ip: "10.8.0.0/16"
    # additional python packages that will be installed with pip
    immunity22_extra_python_packages:
        - bpython
        - django-owm-legacy
    # additional django apps that will be added to settings.INSTALLED_APPS
    # (if the app needs to be installed, the name its python package
    # must be also added to the immunity22_extra_python_packages var)
    immunity22_extra_django_apps:
        - owm_legacy
    # additional django settings example
    immunity22_extra_django_settings:
        CSRF_COOKIE_AGE: 2620800.0
    # in case you need to add python instructions to the django settings file
    immunity22_extra_django_settings_instructions:
        - TEMPLATES[0]['OPTIONS']['loaders'].insert(0, 'apptemplates.Loader')
    # extra URL settings for django
    immunity22_extra_urls:
      - "path(r'', include('my_custom_app.urls'))"
    # allows to specify imports that are used in the websocket routes, eg:
    immunity22_websocket_extra_imports:
      - from my_custom_app.websockets.routing import get_routes as get_custom_app_routes
    # allows to specify extra websocket routes, eg:
    immunity22_websocket_extra_routes:
      # Callable that returns a list of routes
      - get_custom_app_routes()
      # List of routes
      - "[path('ws/custom-app/', consumer.CustomAppConsumer.as_asgi())]"
    # controller URL are enabled by default
    # but can be disabled in multi-VM installations if needed
    immunity22_controller_urls: true
    # The default retention policy that applies to the timeseries data
    # https://github.com/edge-servers/immunity-monitoring#immunity-monitoring-default-retention-policy
    immunity22_monitoring_default_retention_policy: "26280h0m0s" # 3 years
    # whether NGINX should be installed
    immunity22_nginx_install: true
    # spdy protocol support (disabled by default)
    immunity22_nginx_spdy: false
    # HTTP2 protocol support (disabled by default)
    immunity22_nginx_http2: false
    # ipv6 must be enabled explicitly to avoid errors
    immunity22_nginx_ipv6: false
    # nginx client_max_body_size setting
    immunity22_nginx_client_max_body_size: 10M
    # list of upstream servers for Immunity
    immunity22_nginx_immunity_server:
      - "localhost:8000"
    # dictionary containing more nginx settings for
    # the 443 section of the immunity22 nginx configuration
    # IMPORTANT: 1. you can add more nginx settings in this dictionary
    #            2. here we list the default values used
    immunity22_nginx_ssl_config:
        gzip: "on"
        gzip_comp_level: "6"
        gzip_proxied: "any"
        gzip_min_length: "1000"
        gzip_types:
            - "text/plain"
            - "text/html"
            - "image/svg+xml"
            - "application/json"
            - "application/javascript"
            - "text/xml"
            - "text/css"
            - "application/xml"
            - "application/x-font-ttf"
            - "font/opentype"
    # nginx error log configuration
    immunity22_nginx_access_log: "{{ immunity22_path }}/log/nginx.access.log"
    immunity22_nginx_error_log: "{{ immunity22_path }}/log/nginx.error.log error"
    # nginx Content Security Policy header
    immunity22_nginx_csp: >
      "default-src http: https: data: blob: 'unsafe-inline';
      script-src 'unsafe-eval' https: 'unsafe-inline' 'self';
      frame-ancestors 'self'; connect-src https://{{ inventory_hostname }} wss: 'self';
      worker-src https://{{ inventory_hostname }} blob: 'self';" always;
    # uwsgi gid, omitted by default
    immunity22_uwsgi_gid: null
    # number of uWSGI process to spawn. Default value is 1.
    immunity22_uwsgi_processes: 1
    # number of threads each uWSGI process will have. Default value is 1.
    immunity22_uwsgi_threads: 2
    # value of the listen queue of uWSGI
    immunity22_uwsgi_listen: 100
    # socket on which uwsgi should listen. Defaults to UNIX socket
    # at "{{ immunity22_path }}/uwsgi.sock"
    immunity22_uwsgi_socket: 127.0.0.1:8000
    # extra uwsgi configuration parameters that cannot be
    # configured using dedicated ansible variables
    immunity22_uwsgi_extra_conf: |
      single-interpreter=True
      log-4xx=True
      log-5xx=True
      disable-logging=True
      auto-procname=True
    # whether daphne should be installed
    # must be enabled for serving websocket requests
    immunity22_daphne_install: true
    # number of daphne process to spawn. Default value is 1
    immunity22_daphne_processes: 2
    # maximum time to allow a websocket to be connected (in seconds)
    immunity22_daphne_websocket_timeout: 1800
    # the following setting controls which ip address range
    # is allowed to access the immunity22 admin web interface
    # (by default any IP is allowed)
    immunity22_admin_allowed_network: null
    # install ntp client (enabled by default)
    immunity22_install_ntp: true
    # if you have any custom supervisor service, you can
    # configure it to restart along with other supervisor services
    immunity22_extra_supervisor_restart:
        - name: my_custom_service
          when: my_custom_service_enabled
    # Disable usage metric collection. It is enabled by default.
    # Read more about it at
    # https://immunity.io/docs/user/usage-metric-collection.html
    immunity22_usage_metric_collection: false
    # enable sentry example
    immunity22_sentry:
        dsn: "https://7d2e3cd61acc32eca1fb2a390f7b55e1:[email protected]:443/12345"
    immunity22_default_cert_validity: 1825
    immunity22_default_ca_validity: 3650
    # the following options for redis allow to configure an external redis instance if needed
    immunity22_redis_install: true
    immunity22_redis_host: localhost
    immunity22_redis_port: 6379
    immunity22_redis_cache_url: "redis://{{ immunity22_redis_host }}:{{ immunity22_redis_port }}/1"
    # the following options are required to configure influxdb which is used in immunity-monitoring
    immunity22_influxdb_install: true
    immunity22_timeseries_database:
        backend: "immunity_monitoring.db.backends.influxdb"
        user: "immunity"
        password: "immunity"
        name: "immunity22"
        host: "localhost"
        port: 8086
    # celery concurrency for the default queue, by default the number of CPUs is used
    # celery concurrency for the default queue, by default it is set to 1
    # Setting it to "null" will make concurrency equal to number of CPUs if autoscaling is not used
    immunity22_celery_concurrency: null
    # alternative to the previous option, the celery autoscale option can be set if needed
    # for more info, consult the documentation of celery regarding "autoscaling"
    # by default it is set to "null" (no autoscaling)
    immunity22_celery_autoscale: 4,1
    # prefetch multiplier for the default queue,
    # the default value is calculated automatically by celery
    immunity22_celery_prefetch_multiplier: null
    # celery queuing mode for the default queue,
    # leaving the default will work for most cases
    immunity22_celery_optimization: default
    # whether the dedicated celerybeat worker is enabled which is
    # responsible for triggering periodic tasks
    # must be turned on unless there's another server running celerybeat
    immunity22_celerybeat: true
    # whether the dedicated worker for the celery "network" queue is enabled
    # must be turned on unless there's another server running a worker for this queue
    immunity22_celery_network: true
    # concurrency option for the "network" queue (a worker is dedicated solely to network operations)
    # the default is 1. Setting it to "null" will make concurrency equal to number of CPUs if autoscaling is not used.
    immunity22_celery_network_concurrency: null
    # alternative to the previous option, the celery autoscale option can be set if needed
    # for more info, consult the documentation of celery regarding "autoscaling"
    # by default it is set to "null" (no autoscaling)
    immunity22_celery_network_autoscale: 8,4
    # prefetch multiplier for the "network" queue,
    # the default is 1, which mean no prefetching,
    # because the network tasks are long running and is better
    # to distribute the tasks to multiple processes
    immunity22_celery_network_prefetch_multiplier: 1
    # celery queuing mode for the "network" queue,
    # fair mode is used in this case, which means
    # tasks will be equally distributed among workers
    immunity22_celery_network_optimization: fair
    # whether the dedicated worker for the celery "firmware_upgrader" queue is enabled
    # must be turned on unless there's another server running a worker for this queue
    immunity22_celery_firmware_upgrader: true
    # concurrency option for the "firmware_upgrader" queue (a worker is dedicated solely to firmware upgrade operations)
    # the default is 1. Setting it to "null" will make concurrency equal to number of CPUs if autoscaling is not used
    immunity22_celery_firmware_upgrader_concurrency: null
    # alternative to the previous option, the celery autoscale option can be set if needed
    # for more info, consult the documentation of celery regarding "autoscaling"
    # by default it is set to "null" (no autoscaling)
    immunity22_celery_firmware_upgrader_autoscale: 8,4
    # prefetch multiplier for the "firmware_upgrader" queue,
    # the default is 1, which mean no prefetching,
    # because the firmware upgrade tasks are long running and is better
    # to distribute the tasks to multiple processes
    immunity22_celery_firmware_upgrader_prefetch_multiplier: 1
    # celery queuing mode for the "firmware_upgrader" queue,
    # fair mode is used in this case, which means
    # tasks will be equally distributed among workers
    immunity22_celery_firmware_upgrader_optimization: fair
    # whether the dedicated worker for the celery "monitoring" queue is enabled
    # must be turned on unless there's another server running a worker for this queue
    immunity22_celery_monitoring: true
    # concurrency option for the "monitoring" queue (a worker is dedicated solely to monitoring operations)
    # the default is 2. Setting it to "null" will make concurrency equal to number of CPUs
    # if autoscaling is not used.
    immunity22_celery_monitoring_concurrency: null
    # alternative to the previous option, the celery autoscale option can be set if needed
    # for more info, consult the documentation of celery regarding "autoscaling"
    # by default it is set to "null" (no autoscaling)
    immunity22_celery_monitoring_autoscale: 4,8
    # prefetch multiplier for the "monitoring" queue,
    # the default is 1, which mean no prefetching,
    # because the monitoring tasks can be long running and is better
    # to distribute the tasks to multiple processes
    immunity22_celery_monitoring_prefetch_multiplier: 1
    # celery queuing mode for the "monitoring" queue,
    # fair mode is used in this case, which means
    # tasks will be equally distributed among workers
    immunity22_celery_monitoring_optimization: fair
    # whether the default celery task routes should be written to the settings.py file
    # turn this off if you're defining custom task routing rules
    immunity22_celery_task_routes_defaults: true
    # celery settings
    immunity22_celery_broker_url: redis://{{ immunity22_redis_host }}:{{ immunity22_redis_port }}/3
    immunity22_celery_task_acks_late: true
    # maximum number of retries by celery before giving up when broker is unreachable
    immunity22_celery_broker_max_tries: 10
    # whether to activate the django logging configuration in celery
    # if set to true, will log all the celery events in the same log stream used by django
    # which will cause log lines to be written to "{{ immunity22_path }}/log/immunity22.log"
    # instead of "{{ immunity22_path }}/log/celery.log" and "{{ immunity22_path }}/log/celerybeat.log"
    immunity22_django_celery_logging: false
    # postfix is installed by default, set to false if you don't need it
    immunity22_postfix_install: true
    # allow overriding default `postfix_smtp_sasl_auth_enable` variable
    postfix_smtp_sasl_auth_enable_override: true
    # allow overriding postfix_smtpd_relay_restrictions
    postfix_smtpd_relay_restrictions_override: permit_mynetworks
    # allows overriding the default duration for keeping notifications
    immunity22_notifications_delete_old_notifications: 10
    # Expiration time limit (in seconds) of magic sign-in links.
    # Magic sign-in links are used only when Immunity RADIUS is enabled.
    immunity22_django_sesame_max_age: 1800 # 30 minutes
    # Maximum file size(in bytes) allowed to be uploaded as firmware image.
    # It overrides "immunity22_nginx_client_max_body_size" setting
    # and updates nginx configuration accordingly.
    immunity22_firmware_upgrader_max_file_size: 41943040 # 40MB
    # to add multi-language support
    immunity22_internationalization: true
    immunity22_users_auth_api: true
    # Allows setting IMMUNITY_USERS_USER_PASSWORD_EXPIRATION setting.
    # Read https://github.com/edge-servers/immunity-users#immunity_users_user_password_expiration
    immunity22_users_user_password_expiration: 30
      # Allows setting IMMUNITY_USERS_STAFF_USER_PASSWORD_EXPIRATION setting.
    # Read https://github.com/edge-servers/immunity-users#immunity_users_staff_user_password_expiration
    immunity22_users_staff_user_password_expiration: 30
    # used for SMS verification, the default is a dummy SMS backend
    # which prints to standard output and hence does nothing
    # one of the available providers from django-sendsms can be
    # used or alternatively, you can write a backend class for your
    # favorite SMS API gateway
    immunity22_radius_sms_backend: "sendsms.backends.console.SmsBackend"
    immunity22_radius_sms_token_max_ip_daily: 25
    immunity22_radius_delete_old_radiusbatch_users: 365
    immunity22_radius_cleanup_stale_radacct: 1
    immunity22_radius_delete_old_postauth: 365
    # days for which the radius accounting sessions (radacct) are retained,
    # 0 means sessions are kept forever.
    # we highly suggest to set this number according
    # to the privacy regulation of your jurisdiction
    immunity22_radius_delete_old_radacct: 365
    # days after which inactive users will flagged as unverified
    # Read https://immunity-radius.readthedocs.io/en/latest/user/settings.html#immunity-radius-unverify-inactive-users
    immunity22_radius_unverify_inactive_users: 540
    # days after which inactive users will be deleted
    # Read https://immunity-radius.readthedocs.io/en/latest/user/settings.html#immunity-radius-delete-inactive-users
    immunity22_radius_delete_inactive_users: 540
    immunity22_radius_allowed_hosts: ["127.0.0.1"]
    # allow disabling celery beat tasks if needed
    immunity22_monitoring_periodic_tasks: true
    immunity22_radius_periodic_tasks: true
    immunity22_usage_metric_collection_periodic_tasks: true
    # this role provides a default configuration of freeradius
    # if you manage freeradius on a different machine or you need different configurations
    # you can disable this default behavior
    immunity22_freeradius_install: true
    # Set an account to expire T seconds after first login.
    # This variable sets the value of T.
    freeradius_expire_attr_after_seconds: 86400
    freeradius_dir: /etc/freeradius/3.0
    freeradius_mods_available_dir: "{{ freeradius_dir }}/mods-available"
    freeradius_mods_enabled_dir: "{{ freeradius_dir }}/mods-enabled"
    freeradius_sites_available_dir: "{{ freeradius_dir }}/sites-available"
    freeradius_sites_enabled_dir: "{{ freeradius_dir }}/sites-enabled"
    freeradius_rest:
        url: "https://{{ inventory_hostname }}/api/v1/freeradius"
    freeradius_safe_characters: "+@abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_: /"
    # Sets the source path of the template that contains freeradius site configuration.
    # Defaults to "templates/freeradius/immunity_site.j2" shipped in the role.
    freeradius_immunity_site_template_src: custom_freeradius_site.j2
    # FreeRADIUS listen address for the immunity_site.
    # Defaults to "*", i.e. listen on all interfaces.
    freeradius_immunity_site_listen_ipaddr: "10.8.0.1"
    cron_delete_old_notifications: "'hour': 0, 'minute': 0"
    cron_deactivate_expired_users: "'hour': 0, 'minute': 5"
    cron_delete_old_radiusbatch_users: "'hour': 0, 'minute': 10"
    cron_cleanup_stale_radacct: "'hour': 0, 'minute': 20"
    cron_delete_old_postauth: "'hour': 0, 'minute': 30"
    cron_delete_old_radacct: "'hour': 1, 'minute': 30"
    cron_password_expiration_email: "'hour': 1, 'minute': 0"
    cron_unverify_inactive_users: "'hour': 1, 'minute': 45"
    cron_delete_inactive_users: "'hour': 1, 'minute': 55"
    # cross-origin resource sharing (CORS) settings
    # https://pypi.org/project/django-cors-headers/
    immunity22_django_cors:
      # Setting this to "true" will install the django-cors-headers package
      # and configure the Django middleware setting to support CORS.
      # By default, it is set to false.
      enabled: true
      # Configures "CORS_ALLOWED_ORIGINS" setting of the django-cors-headers
      # package. A list of origins that are authorized to make cross-site
      # HTTP requests. Read https://github.com/adamchainz/django-cors-headers#cors_allowed_origins-sequencestr
      # for detail. By default, it is set to an empty list.
      allowed_origins_list: ["https://log.immunity.org"]
      # Configures "CORS_REPLACE_HTTPS_REFERER" setting of the django-cors-headers
      # package. Read https://github.com/adamchainz/django-cors-headers#cors_replace_https_referer-bool
      # for detail. Setting this to "true" will also configure the
      # Django middleware setting to add "CorsPostCsrfMiddleware".
      # By default, it is set to false.
      replace_https_referer: true

Note: The default values for settings provided to control the number of process and threads of uWSGI and Daphne are set conservatively. It is expected from user to update these settings to suit scale of their project. The same thing applies for concurrency and autoscale settings for celery workers.

Support

See Immunity Support Channels.