Skip to main content
MemMachine uses a client-server architecture. The Server manages the storage, retrieval, and processing of memories, while your application uses a Client SDK to interact with it. This guide focuses on getting the MemMachine Server up and running.

​
Installation

The fastest method to get started with MemMachine is by using Docker and Docker Compose. This approach bundles all necessary components into containers, simplifying the setup process.

​
Prerequisites

Before installing MemMachine, ensure you have the following prerequisites:
  • Docker & Docker Compose - Required to run the server containers.
  • OpenAI API Key - For language models and embeddings (configured in the server).

​
Download and Start the Server

1

Install Docker

Make sure that you have Docker and Docker Compose installed on your machine.
2

Download MemMachine and Run

Open your terminal and run the following commands:
# Download the latest MemMachine release tarball
TARBALL_URL=$(curl -s https://api.github.com/repos/MemMachine/MemMachine/releases/latest \
  | grep '"tarball_url"' \
  | head -n 1 \
  | sed -E 's/.*"tarball_url": "(.*)",/\1/')

curl -L "$TARBALL_URL" -o MemMachine-latest.tar.gz

# Extract the release archive
tar -xzf MemMachine-latest.tar.gz

# Move into the extracted directory (GitHub adds a commit hash to the folder name)
cd MemMachine-MemMachine-*/

# Start the MemMachine installation
./memmachine-compose.sh
The script will walk you through the setup process, including configuring your OpenAI API key.
3

Verify Installation

Once the script completes, your MemMachine server should be running. You can verify it by checking the health endpoint:
curl http://localhost:8080/health
You should receive a response indicating the server status is healthy.

​
Next Steps: Connect Your App

Now that the server is running, you need to install the Python Client SDK to interact with it from your application.

Python Client Guide

Install the SDK and write your first “Hello World” program.

API Reference

Explore the full REST API documentation.

​
Management Scripts

The memmachine-compose.sh script is your main tool for managing the server. 
./memmachine-compose.sh --help
Common commands:
  • ./memmachine-compose.sh stop - Stop the services.
  • ./memmachine-compose.sh restart - Restart the services.
  • ./memmachine-compose.sh logs - View server logs.