skpassegna/openmemory-ui repository overview

⁠OpenMemory UI

This Docker image contains the frontend user interface for OpenMemory.

OpenMemory is your personal memory layer for LLMs - private, portable, and open-source. This UI provides a dashboard to manage your memories, connected applications, and system settings.

⁠Features

• Dashboard: View overall statistics, and quick installation guides for MCP clients.
• Memory Management:
  • Create, view, update, and delete memories.
  • Filter memories by content, application, categories, and date.
  • Sort memories by various criteria.
  • View detailed information for each memory, including access logs and related memories.
  • Manage memory states (active, pause, archive).
• Application Management:
  • List applications that have interacted with OpenMemory.
  • View statistics for each application (memories created/accessed).
  • Toggle application access (active/inactive).
• System Settings:
  • Configure LLM and Embedder providers (e.g., OpenAI, Ollama, Mistral AI).
  • Manage API keys and model parameters for the selected providers.
  • Set custom instructions for memory processing.
  • View and edit configuration in both Form and JSON views.

⁠How to Run

This image is designed to be run as part of the OpenMemory stack, typically orchestrated with Docker Compose. For the easiest setup, refer to the docker-compose.yml or run.sh script in the main OpenMemory GitHub repository⁠.

Basic Docker Run Example (requires the OpenMemory API/MCP server to be running):

docker run -d \
  --name openmemory-ui-container \
  -p 3000:3000 \
  -e NEXT_PUBLIC_API_URL="http://<your_api_host_or_ip>:8765" \
  -e NEXT_PUBLIC_USER_ID="$(whoami)" \
  skpassegna/openmemory-ui:latest

Required Services:

• OpenMemory API/MCP Server: The UI needs to connect to a running instance of the skpassegna/openmemory-mcp (or equivalent) backend service.

⁠Environment Variables

• NEXT_PUBLIC_API_URL (Required): The full URL where the frontend can reach the backend API.
  • Example: http://localhost:8765 or http://api.example.com
• NEXT_PUBLIC_USER_ID (Required): The default user ID for the UI to operate under.
  • Example: yourusername
• PORT (Optional): The port on which the Next.js server will listen inside the container.
  • Default: 3000 (This is then mapped to a host port using docker run -p <host_port>:3000).

⁠Ports Exposed

• 3000: The default port on which the Next.js application server listens inside the container.

⁠Source Code

The source code for this UI can be found in the ui/ directory of the OpenMemory GitHub repository⁠.

⁠Contributing

OpenMemory welcomes contributions! Please see the CONTRIBUTING.md⁠ file in the main repository for guidelines.