memos Documentation

File: README.md Copy Chapter

✨ Featured Sponsor: CodeRabbit — Cut code review time & bugs in half, instantly.

Memos

Memos is an open-source, self-hosted note-taking app built for quick capture. It is Markdown-native, lightweight, and keeps your data under your control.

Features Copy Chapter

• Capture quickly — A timeline-first interface keeps note-taking simple: open, write, and move on.
• Own your data — Self-host Memos on your infrastructure with no telemetry.
• Deploy anywhere — Run a single Go binary or Docker container with SQLite, MySQL, or PostgreSQL.
• Integrate freely — Build on the REST and gRPC APIs or adapt the MIT-licensed source to your needs.

Quick Start Copy Chapter

Want to explore Memos first? Open the live demo.

Docker (Recommended) Copy Section

docker run -d \
  --name memos \
  -p 5230:5230 \
  -v ~/.memos:/var/opt/memos \
  neosmemo/memos:stable

Open http://localhost:5230 and start writing.

Native Binary Copy Section

curl -fsSL https://raw.githubusercontent.com/usememos/memos/main/scripts/install.sh | sh

Other Installation Methods Copy Section

• Docker Compose — Recommended for production deployments.
• Kubernetes — Helm charts and manifests are available.
• Build from source — Best for development and customization.

See the deployment guide for detailed instructions.

Web Clipper Copy Chapter

Save pages, selected text, and images directly to your Memos instance with the official Memos Web Clipper. The extension is available for Chrome and Firefox, and lets you review each clip, choose its visibility, and customize its Markdown format before saving.

Contributing Copy Chapter

Contributions of all kinds are welcome, including bug reports, feature suggestions, pull requests, documentation, and translations.

• Report bugs
• Suggest features
• Submit pull requests
• Improve documentation
• Help with translations

Sponsors Copy Chapter

• CodeRabbit — Cut code review time and bugs in half
• SSD Nodes — Affordable VPS hosting for self-hosters
• TestMu AI — The world’s first full-stack Agentic AI Quality Engineering platform

Love Memos? Sponsor us on GitHub to help keep the project growing!

License Copy Chapter

Memos is open-source software licensed under the MIT License. See our Privacy Policy for details on data handling.

Website • Documentation • Demo • Discord • X/Twitter

File: proto/api/v1/README.md Copy Chapter

Memos API Design

This API design should follow the guidelines and best practices outlined in the Google API Improvement Proposals (AIPs).

File: proto/README.md Copy Chapter

Guide

Prerequisites Copy Chapter

• buf

Generate Copy Chapter

buf generate

Format Copy Chapter

buf format -w