/meilisync-go

An implementation of meilisync in golang.

Primary LanguageGoBoost Software License 1.0BSL-1.0

Meilisync-Go

Meilisync-Go is a rewrite of the original python version of meilisync in Go. It has significantly fewer features (at this point in time).

Getting Started

Prerequisites

Before you begin, ensure you have the following requirements:

  • Access to a running MySQL database.
  • Access to a Meilisearch instance.
  • A working docker installation

Installation

Meilisync-Go can be run using Docker. A Docker image is available on Docker Hub at patsore/meilisync-go. To get started, follow these steps:

  1. Pull the Docker image from Docker Hub:
docker pull patsore/meilisync-go:main

Set up your configuration file on your local machine. Create a config.toml file with your MySQL and Meilisearch connection settings. (see example here)

Run Meilisync-Go using Docker, specifying the location of your configuration file and the volume where progress should be saved. Replace /my/meilisync/location/ with the actual path to your configuration file on your local machine:

docker run -d -e MEILISYNC_CONFIG_LOCATION=/app/config.toml -v /my/meilisync/location/:/app patsore/meilisync-go:main

Meilisync-Go will run inside the Docker container, using the configuration file you provided. It will continuously synchronize your MySQL data to the Meilisearch index according to the configuration, and save the progress to the folder you mounted.

Monitor the synchronization process and ensure that your data is being indexed correctly.

License

See LICENSE for this project's license.