Meilisearch¶

Overview¶

Meilisearch is an AI powered search tool.

Manual

Releases

Community

Configuration¶

Use the sb inventory system to set any environment variables that are desired.

See Meilisearch Environment Variables for supported variables

Deployment¶

sb install sandbox-meilisearch

Usage¶

Port 7700 is open to the container by default. Also analytics are disabled by default.

Visit https://www.meilisearch.com/docs.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
meilisearch_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like meilisearch_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like meilisearch_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsDockerDocker+Global Override Options

meilisearch_name

# Type: string
meilisearch_name: meilisearch

Container

meilisearch_role_docker_container

# Type: string
meilisearch_role_docker_container: "{{ meilisearch_name }}"

Image

meilisearch_role_docker_image_pull

# Type: bool (true/false)
meilisearch_role_docker_image_pull: true

meilisearch_role_docker_image_repo

# Type: string
meilisearch_role_docker_image_repo: "getmeili/meilisearch"

meilisearch_role_docker_image

# Type: string
meilisearch_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='meilisearch') }}:{{ lookup('role_var', '_docker_image_tag', role='meilisearch') }}"

meilisearch_role_docker_image_tag

# Type: string
meilisearch_role_docker_image_tag: "v1.11.1"

Envs

meilisearch_role_docker_envs_default

# Type: dict
meilisearch_role_docker_envs_default:
  TZ: "{{ tz }}"
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  MEILI_NO_ANALYTICS: "true"
  MEILI_MASTER_KEY: "{{ meilisearch_saltbox_facts.facts.secret_key }}"

meilisearch_role_docker_envs_custom

# Type: dict
meilisearch_role_docker_envs_custom: {}

Volumes

meilisearch_role_docker_volumes_default

# Type: list
meilisearch_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='meilisearch') }}/data:/meili_data"

meilisearch_role_docker_volumes_custom

# Type: list
meilisearch_role_docker_volumes_custom: []

Hostname

meilisearch_role_docker_hostname

# Type: string
meilisearch_role_docker_hostname: "{{ meilisearch_name }}"

Networks

meilisearch_role_docker_networks_alias

# Type: string
meilisearch_role_docker_networks_alias: "{{ meilisearch_name }}"

meilisearch_role_docker_networks_default

# Type: list
meilisearch_role_docker_networks_default: []

meilisearch_role_docker_networks_custom

# Type: list
meilisearch_role_docker_networks_custom: []

Restart Policy

meilisearch_role_docker_restart_policy

# Type: string
meilisearch_role_docker_restart_policy: unless-stopped

State

meilisearch_role_docker_state

# Type: string
meilisearch_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

meilisearch_role_docker_blkio_weight

# Type: int
meilisearch_role_docker_blkio_weight:

meilisearch_role_docker_cpu_period

# Type: int
meilisearch_role_docker_cpu_period:

meilisearch_role_docker_cpu_quota

# Type: int
meilisearch_role_docker_cpu_quota:

meilisearch_role_docker_cpu_shares

# Type: int
meilisearch_role_docker_cpu_shares:

meilisearch_role_docker_cpus

# Type: string
meilisearch_role_docker_cpus:

meilisearch_role_docker_cpuset_cpus

# Type: string
meilisearch_role_docker_cpuset_cpus:

meilisearch_role_docker_cpuset_mems

# Type: string
meilisearch_role_docker_cpuset_mems:

meilisearch_role_docker_kernel_memory

# Type: string
meilisearch_role_docker_kernel_memory:

meilisearch_role_docker_memory

# Type: string
meilisearch_role_docker_memory:

meilisearch_role_docker_memory_reservation

# Type: string
meilisearch_role_docker_memory_reservation:

meilisearch_role_docker_memory_swap

# Type: string
meilisearch_role_docker_memory_swap:

meilisearch_role_docker_memory_swappiness

# Type: int
meilisearch_role_docker_memory_swappiness:

meilisearch_role_docker_shm_size

# Type: string
meilisearch_role_docker_shm_size:

Security & Devices

meilisearch_role_docker_cap_drop

# Type: list
meilisearch_role_docker_cap_drop:

meilisearch_role_docker_cgroupns_mode

# Type: string
meilisearch_role_docker_cgroupns_mode:

meilisearch_role_docker_device_cgroup_rules

# Type: list
meilisearch_role_docker_device_cgroup_rules:

meilisearch_role_docker_device_read_bps

# Type: list
meilisearch_role_docker_device_read_bps:

meilisearch_role_docker_device_read_iops

# Type: list
meilisearch_role_docker_device_read_iops:

meilisearch_role_docker_device_requests

# Type: list
meilisearch_role_docker_device_requests:

meilisearch_role_docker_device_write_bps

# Type: list
meilisearch_role_docker_device_write_bps:

meilisearch_role_docker_device_write_iops

# Type: list
meilisearch_role_docker_device_write_iops:

meilisearch_role_docker_devices

# Type: list
meilisearch_role_docker_devices:

meilisearch_role_docker_devices_default

# Type: string
meilisearch_role_docker_devices_default:

meilisearch_role_docker_groups

# Type: list
meilisearch_role_docker_groups:

meilisearch_role_docker_privileged

# Type: bool (true/false)
meilisearch_role_docker_privileged:

meilisearch_role_docker_security_opts

# Type: list
meilisearch_role_docker_security_opts:

meilisearch_role_docker_user

# Type: string
meilisearch_role_docker_user:

meilisearch_role_docker_userns_mode

# Type: string
meilisearch_role_docker_userns_mode:

Networking

meilisearch_role_docker_dns_opts

# Type: list
meilisearch_role_docker_dns_opts:

meilisearch_role_docker_dns_search_domains

# Type: list
meilisearch_role_docker_dns_search_domains:

meilisearch_role_docker_dns_servers

# Type: list
meilisearch_role_docker_dns_servers:

meilisearch_role_docker_domainname

# Type: string
meilisearch_role_docker_domainname:

meilisearch_role_docker_exposed_ports

# Type: list
meilisearch_role_docker_exposed_ports:

meilisearch_role_docker_hosts

# Type: dict
meilisearch_role_docker_hosts:

meilisearch_role_docker_hosts_use_common

# Type: bool (true/false)
meilisearch_role_docker_hosts_use_common:

meilisearch_role_docker_ipc_mode

# Type: string
meilisearch_role_docker_ipc_mode:

meilisearch_role_docker_links

# Type: list
meilisearch_role_docker_links:

meilisearch_role_docker_network_mode

# Type: string
meilisearch_role_docker_network_mode:

meilisearch_role_docker_pid_mode

# Type: string
meilisearch_role_docker_pid_mode:

meilisearch_role_docker_ports

# Type: list
meilisearch_role_docker_ports:

meilisearch_role_docker_uts

# Type: string
meilisearch_role_docker_uts:

Storage

meilisearch_role_docker_keep_volumes

# Type: bool (true/false)
meilisearch_role_docker_keep_volumes:

meilisearch_role_docker_mounts

# Type: list
meilisearch_role_docker_mounts:

meilisearch_role_docker_storage_opts

# Type: dict
meilisearch_role_docker_storage_opts:

meilisearch_role_docker_tmpfs

# Type: list
meilisearch_role_docker_tmpfs:

meilisearch_role_docker_volume_driver

# Type: string
meilisearch_role_docker_volume_driver:

meilisearch_role_docker_volumes_from

# Type: list
meilisearch_role_docker_volumes_from:

meilisearch_role_docker_volumes_global

# Type: bool (true/false)
meilisearch_role_docker_volumes_global:

meilisearch_role_docker_working_dir

# Type: string
meilisearch_role_docker_working_dir:

Monitoring & Lifecycle

meilisearch_role_docker_auto_remove

# Type: bool (true/false)
meilisearch_role_docker_auto_remove:

meilisearch_role_docker_cleanup

# Type: bool (true/false)
meilisearch_role_docker_cleanup:

meilisearch_role_docker_force_kill

# Type: string
meilisearch_role_docker_force_kill:

meilisearch_role_docker_healthcheck

# Type: dict
meilisearch_role_docker_healthcheck:

meilisearch_role_docker_healthy_wait_timeout

# Type: int
meilisearch_role_docker_healthy_wait_timeout:

meilisearch_role_docker_init

# Type: bool (true/false)
meilisearch_role_docker_init:

meilisearch_role_docker_kill_signal

# Type: string
meilisearch_role_docker_kill_signal:

meilisearch_role_docker_log_driver

# Type: string
meilisearch_role_docker_log_driver:

meilisearch_role_docker_log_options

# Type: dict
meilisearch_role_docker_log_options:

meilisearch_role_docker_oom_killer

# Type: bool (true/false)
meilisearch_role_docker_oom_killer:

meilisearch_role_docker_oom_score_adj

# Type: int
meilisearch_role_docker_oom_score_adj:

meilisearch_role_docker_output_logs

# Type: bool (true/false)
meilisearch_role_docker_output_logs:

meilisearch_role_docker_paused

# Type: bool (true/false)
meilisearch_role_docker_paused:

meilisearch_role_docker_recreate

# Type: bool (true/false)
meilisearch_role_docker_recreate:

meilisearch_role_docker_restart_retries

# Type: int
meilisearch_role_docker_restart_retries:

meilisearch_role_docker_stop_timeout

# Type: int
meilisearch_role_docker_stop_timeout:

Other Options

meilisearch_role_docker_capabilities

# Type: list
meilisearch_role_docker_capabilities:

meilisearch_role_docker_cgroup_parent

# Type: string
meilisearch_role_docker_cgroup_parent:

meilisearch_role_docker_commands

# Type: list
meilisearch_role_docker_commands:

meilisearch_role_docker_create_timeout

# Type: int
meilisearch_role_docker_create_timeout:

meilisearch_role_docker_entrypoint

# Type: string
meilisearch_role_docker_entrypoint:

meilisearch_role_docker_env_file

# Type: string
meilisearch_role_docker_env_file:

meilisearch_role_docker_labels

# Type: dict
meilisearch_role_docker_labels:

meilisearch_role_docker_labels_use_common

# Type: bool (true/false)
meilisearch_role_docker_labels_use_common:

meilisearch_role_docker_read_only

# Type: bool (true/false)
meilisearch_role_docker_read_only:

meilisearch_role_docker_runtime

# Type: string
meilisearch_role_docker_runtime:

meilisearch_role_docker_sysctls

# Type: list
meilisearch_role_docker_sysctls:

meilisearch_role_docker_ulimits

# Type: list
meilisearch_role_docker_ulimits:

meilisearch_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
meilisearch_role_autoheal_enabled: true

meilisearch_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
meilisearch_role_depends_on: ""

meilisearch_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
meilisearch_role_depends_on_delay: "0"

meilisearch_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
meilisearch_role_depends_on_healthchecks:

meilisearch_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
meilisearch_role_diun_enabled: true

meilisearch_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
meilisearch_role_docker_controller: true

meilisearch_role_docker_image_repo

# Type: string
meilisearch_role_docker_image_repo:

meilisearch_role_docker_image_tag

# Type: string
meilisearch_role_docker_image_tag:

meilisearch_role_docker_volumes_download

# Type: bool (true/false)
meilisearch_role_docker_volumes_download:

meilisearch_role_paths_location

# Type: string
meilisearch_role_paths_location: