hachyderm.general.anubis role – Install and configure Anubis

Note

This role is part of the hachyderm.general collection (version 1.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install hachyderm.general.

To use it in a playbook, specify: hachyderm.general.anubis.

Entry point main – Install and configure Anubis

Synopsis

Parameters

Parameter

Comments

anubis_arch

string

Architecture of the system to install Anubis.

Default: "amd64"

anubis_asset_lookup_header

string

Define the ASSET_LOOKUP_HEADER environment variable.

anubis_base_prefix

string

Define the BASE_PREFIX environment variable.

anubis_bbolt_path

path

Path to the BBolt store backend.

anubis_bind

string

Define the BIND environment variable.

Default: ":8923"

anubis_bind_network

string

Define the BIND_NETWORK environment variable.

anubis_bot_policies

dictionary

Configure bot policies.

See Policy Definitions.

Default: {}

anubis_challenge_title

string

Define the CHALLENGE_TITLE environment variable.

string

Define the COOKIE_DOMAIN environment variable.

boolean

Define the COOKIE_DYNAMIC_DOMAIN environment variable.

Choices:

  • false

  • true

string

Define the COOKIE_EXPIRATION_TIME environment variable.

boolean

Define the COOKIE_PARTITIONED environment variable.

Choices:

  • false

  • true

string

Define the COOKIE_PREFIX environment variable.

string

Define the COOKIE_SAME_SITE environment variable.

boolean

Define the COOKIE_SECURE environment variable.

Choices:

  • false

  • true

anubis_custom_real_ip_header

string

Define the CUSTOM_REAL_IP_HEADER environment variable.

anubis_deb

string

URL of the debian package to install.

Default: "https://github.com/TecharoHQ/anubis/releases/download/ v{{ anubis_version }}/anubis_{{ anubis_version }}_{{ anubis_arch }}.deb"

anubis_difficulty

integer

Define the DIFFICULTY environment variable.

Default: 4

anubis_difficulty_in_jwt

boolean

Define the DIFFICULTY_IN_JWT environment variable.

Choices:

  • false

  • true

anubis_ed25519_private_key_hex

string

Define the ED25519_PRIVATE_KEY_HEX environment variable.

anubis_ed25519_private_key_hex_file

string

Define the ED25519_PRIVATE_KEY_HEX_FILE environment variable.

anubis_error_title

string

Define the ERROR_TITLE environment variable.

anubis_forced_language

string

Define the FORCED_LANGUAGE environment variable.

anubis_hs512_secret

string

Define the HS512_SECRET environment variable.

anubis_jwt_restriction_header

string

Define the JWT_RESTRICTION_HEADER environment variable.

anubis_metrics_bind

string

Define the METRICS_BIND environment variable.

Default: ":9090"

anubis_metrics_bind_network

string

Define the METRICS_BIND_NETWORK environment variable.

anubis_og_cache_consider_host

boolean

Define the OG_CACHE_CONSIDER_HOST environment variable.

Choices:

  • false

  • true

anubis_og_expiry_time

string

Define the OG_EXPIRY_TIME environment variable.

anubis_og_passthrough

boolean

Define the OG_PASSTHROUGH environment variable.

Choices:

  • false

  • true

anubis_overlay_folder

string

Define the OVERLAY_FOLDER environment variable.

anubis_policy_fname

path

Define the POLICY_FNAME environment variable.

Default: "/etc/anubis/default.botPolicies.yaml"

anubis_public_url

string

Define the PUBLIC_URL environment variable.

anubis_redirect_domains

list / elements=string

Define the REDIRECT_DOMAINS environment variable.

Expect a list of domains that will be transformed to a coma separated list.

anubis_serve_robots_txt

boolean

Define the SERVE_ROBOTS_TXT environment variable.

Choices:

  • false

  • true

anubis_slog_level

string

Define the SLOG_LEVEL environment variable.

anubis_socket_mode

string

Define the SOCKET_MODE environment variable.

anubis_strip_base_prefix

boolean

Define the STRIP_BASE_PREFIX environment variable.

Choices:

  • false

  • true

anubis_target

string

Define the TARGET environment variable.

Default: "http://localhost:3923"

anubis_target_disable_keepalive

boolean

Define the TARGET_DISABLE_KEEPALIVE environment variable.

Choices:

  • false

  • true

anubis_target_host

string

Define the TARGET_HOST environment variable.

anubis_target_insecure_skip_verify

boolean

Define the TARGET_INSECURE_SKIP_VERIFY environment variable.

Choices:

  • false

  • true

anubis_target_sni

string

Define the TARGET_SNI environment variable.

anubis_use_remote_address

string

Define the USE_REMOTE_ADDRESS environment variable.

anubis_use_simplified_explanation

boolean

Define the USE_SIMPLIFIED_EXPLANATION environment variable.

Choices:

  • false

  • true

anubis_use_templates

boolean

Define the USE_TEMPLATES environment variable.

Choices:

  • false

  • true

anubis_valkey_url

string

URL of the Valkey store backend.

anubis_version

string

Version of the binary.

See releases.

Default: "1.25.0"

anubis_webmaster_email

string

Define the WEBMASTER_EMAIL environment variable.

anubis_xff_strip_private

boolean

Define the XFF_STRIP_PRIVATE environment variable.

Choices:

  • false

  • true

Authors

  • Hachyderm contributors