nfrastack/container-meilisearch

About

This repository will build a container for meilisearch. A lightning-fast search engine API.

Maintainer

• Nfrastack

Table of Contents

• About
• Maintainer
• Table of Contents
• Installation
  • Prebuilt Images
  • Quick Start
  • Persistent Storage
• Environment Variables
  • Base Images used
  • Core Configuration
  • Meilisearch Configuration
• Users and Groups
• Networking
• Maintenance
  • Shell Access
• Support & Maintenance
• License

Installation

Prebuilt Images

Feature limited builds of the image are available on the Github Container Registry and Docker Hub.

To unlock advanced features, one must provide a code to be able to change specific environment variables from defaults. Support the development to gain access to a code.

To get access to the image use your container orchestrator to pull from the following locations:

ghcr.io/nfrastack/container-meilisearch:(image_tag)
docker.io/nfrastack/meilisearch:(image_tag)

Image tag syntax is:

<image>:<optional tag>-<optional_distribution>_<optional_distribution_variant>

Example:

ghcr.io/nfrastack/container-meilisearch:latest or

ghcr.io/nfrastack/container-meilisearch:1.0 or

ghcr.io/nfrastack/container-meilisearch:1.0-alpine or

ghcr.io/nfrastack/container-meilisearch:alpine

• latest will be the most recent commit
• An optional tag may exist that matches the CHANGELOG - These are the safest
• If it is built for multiple distributions there may exist a value of alpine or debian
• If there are multiple distribution variations it may include a version - see the registry for availability

Have a look at the container registries and see what tags are available.

Multi-Architecture Support

Images are built for amd64 by default, with optional support for arm64 and other architectures.

Quick Start

• The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for your use.

• Map persistent storage for access to configuration and data files for backup.

• Set various environment variables to understand the capabilities of this image.

Persistent Storage

The following directories are used for configuration and can be mapped for persistent storage.

Directory	Description
/config/	(optional) Config Files
/data/	Data Files
/logs/	Logfiles

Environment Variables

Base Images used

This image relies on a customized base image in order to work. Be sure to view the following repositories to understand all the customizable options:

Image	Description
OS Base	Base Image

Below is the complete list of available options that can be used to customize your installation.

• Variables showing an 'x' under the Advanced column can only be set if the containers advanced functionality is enabled.

Core Configuration

Parameter	Description	Default	Advanced
MEILISEARCH_SETUP_TYPE	Auto Configure Configuration each startup - Set to MANUAL to disable	AUTO
CONFIG_PATH	Path to configuration directory	/config/
CONFIG_FILE	Name of the config file	meilisearch.conf
DATA_PATH	Path to data directory	/data/
DB_PATH	Path to database file	${DATA_PATH}/db/
DUMP_PATH	Path to dump directory	${DATA_PATH}/dumps/
LOG_PATH	Path to logs directory	/logs/
LOG_FILE	Log file name	meilisearch.log
LOG_LEVEL	Log level OFF ERROR WARN INFO DEBUG TRACE	INFO
LOG_TYPE	Log to CONSOLE FILE BOTH or NONE	CONSOLE
SNAPSHOT_PATH	Path to snapshot directory	${DATA_PATH}/snapshots/
MEILISEARCH_ADDITIONAL_ARGS	Additional arguments to pass to meilisearch execution

Meilisearch Configuration

Parameter	Description	Default	Advanced	_FILE
ENVIRONMENT	Environment (production/development)	PRODUCTION
MASTER_KEY	Master Key used for securing API	``		x
MEILISEARCH_USER	User running Meilisearch	meilisearch
MEILISEARCH_GROUP	Group running Meilisearch	meilisearch
LISTEN_IP	IP address to listen on	0.0.0.0
LISTEN_PORT	Port to listen on	7700
ENABLE_ANALYTICS	Enable/disable analytics	FALSE
ENABLE_METRICS	Enable/disable metrics	FALSE	x
HTTP_PAYLOAD_SIZE_LIMIT	Max HTTP payload size	100MB
IGNORE_DUMP_IF_DB_EXISTS	Ignore dump if DB exists	FALSE
IGNORE_MISSING_DUMP	Ignore missing dump	FALSE
IGNORE_MISSING_SNAPSHOT	Ignore missing snapshot	FALSE
IGNORE_SNAPSHOT_IF_DB_EXISTS	Ignore snapshot if DB exists	FALSE
MAX_INDEXING_MEMORY	Max memory for indexing (kB, 66% of available by default)	Calculated at runtime
MAX_INDEXING_THREADS	Max threads for indexing	0
MAX_NUMBER_OF_BATCHED_TASKS	Max number of batched tasks (experimental)	``	x
REDUCE_INDEXING_MEMORY_USAGE	Reduce memory usage during indexing (experimental)	FALSE	x
SCHEDULE_SNAPSHOT	Enable scheduled snapshots	FALSE
SSL_AUTH_PATH	Path for SSL client authentication	``	x
SSL_CERT_PATH	Path to SSL certificate	``	x
SSL_KEY_PATH	Path to SSL key	``	x
SSL_OCSP_PATH	Path to SSL OCSP file	``	x
SSL_REQUIRE_AUTH	Require SSL authentication	FALSE	x
SSL_RESUMPTION	Enable SSL session resumption	FALSE	x
SSL_TICKETS	Enable SSL tickets	FALSE	x

Users and Groups

Type	Name	ID
User	meilisearch	7700
Group	meilisearch	7700

Networking

Port	Protocol	Description
7700	tcp+udp	Meilsearch

---

Maintenance

Shell Access

For debugging and maintenance, bash and sh are available in the container.

Support & Maintenance

• For community help, tips, and community discussions, visit the Discussions board.
• For personalized support or a support agreement, see Nfrastack Support.
• To report bugs, submit a Bug Report. Usage questions will be closed as not-a-bug.
• Feature requests are welcome, but not guaranteed. For prioritized development, consider a support agreement.
• Updates are best-effort, with priority given to active production use and support agreements.

License

This project is licensed under the MIT License - see the LICENSE file for details.