mirror of https://github.com/usememos/memos.git
140 lines
5.7 KiB
Markdown
140 lines
5.7 KiB
Markdown
# Memos
|
||
|
||
<img align="right" height="96px" src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/logo-rounded.png" alt="Memos" />
|
||
|
||
An open-source, self-hosted note-taking service. Your thoughts, your data, your control — no tracking, no ads, no subscription fees.
|
||
|
||
[](https://usememos.com)
|
||
[](https://demo.usememos.com/)
|
||
[](https://usememos.com/docs)
|
||
[](https://discord.gg/tfPJa4UmAv)
|
||
[](https://hub.docker.com/r/neosmemo/memos)
|
||
|
||
<img src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/demo.png" alt="Memos Demo Screenshot" height="512" />
|
||
|
||
### 💎 Featured Sponsors
|
||
|
||
[**Warp** — The AI-powered terminal built for speed and collaboration](https://go.warp.dev/memos)
|
||
|
||
<a href="https://go.warp.dev/memos" target="_blank" rel="noopener">
|
||
<img src="https://raw.githubusercontent.com/warpdotdev/brand-assets/main/Github/Sponsor/Warp-Github-LG-02.png" alt="Warp - The AI-powered terminal built for speed and collaboration" width="512" />
|
||
</a>
|
||
|
||
---
|
||
|
||
[**TestMu AI** - The world’s first full-stack Agentic AI Quality Engineering platform](https://www.testmu.ai/?utm_source=memos&utm_medium=sponsor)
|
||
|
||
<a href="https://www.testmu.ai/?utm_source=memos&utm_medium=sponsor" target="_blank" rel="noopener">
|
||
<img src="https://usememos.com/sponsors/testmu.svg" alt="TestMu AI" height="36" />
|
||
</a>
|
||
|
||
## Overview
|
||
|
||
Memos is a privacy-first, self-hosted knowledge base that works seamlessly for personal notes, team wikis, and knowledge management. Built with Go and React, it offers lightning-fast performance without compromising on features or usability.
|
||
|
||
**Why choose Memos over cloud services?**
|
||
|
||
| Feature | Memos | Cloud Services |
|
||
| ----------------- | ------------------------------ | ----------------------------- |
|
||
| **Privacy** | ✅ Self-hosted, zero telemetry | ❌ Your data on their servers |
|
||
| **Cost** | ✅ Free forever, MIT license | ❌ Subscription fees |
|
||
| **Performance** | ✅ Instant load, no latency | ⚠️ Depends on internet |
|
||
| **Ownership** | ✅ Full control & export | ❌ Vendor lock-in |
|
||
| **API Access** | ✅ Full REST + gRPC APIs | ⚠️ Limited or paid |
|
||
| **Customization** | ✅ Open source, forkable | ❌ Closed ecosystem |
|
||
|
||
## Features
|
||
|
||
- **🔒 Privacy-First Architecture**
|
||
|
||
- Self-hosted on your infrastructure with zero telemetry
|
||
- Complete data ownership and export capabilities
|
||
- No tracking, no ads, no vendor lock-in
|
||
|
||
- **📝 Markdown Native**
|
||
|
||
- Full markdown support
|
||
- Plain text storage — take your data anywhere
|
||
|
||
- **⚡ Blazing Fast**
|
||
|
||
- Built with Go backend and React frontend
|
||
- Optimized for performance at any scale
|
||
|
||
- **🐳 Simple Deployment**
|
||
|
||
- One-line Docker installation
|
||
- Supports SQLite, MySQL, and PostgreSQL
|
||
|
||
- **🔗 Developer-Friendly**
|
||
|
||
- Full REST and gRPC APIs
|
||
- Easy integration with existing workflows
|
||
|
||
- **🎨 Beautiful Interface**
|
||
- Clean, minimal design and dark mode support
|
||
- Mobile-responsive layout
|
||
|
||
## Quick Start
|
||
|
||
### Docker (Recommended)
|
||
|
||
```bash
|
||
docker run -d \
|
||
--name memos \
|
||
-p 5230:5230 \
|
||
-v ~/.memos:/var/opt/memos \
|
||
neosmemo/memos:stable
|
||
```
|
||
|
||
Open `http://localhost:5230` and start writing!
|
||
|
||
### Try the Live Demo
|
||
|
||
Don't want to install yet? Try our [live demo](https://demo.usememos.com/) first!
|
||
|
||
### Other Installation Methods
|
||
|
||
- **Docker Compose** - Recommended for production deployments
|
||
- **Pre-built Binaries** - Available for Linux, macOS, and Windows
|
||
- **Kubernetes** - Helm charts and manifests available
|
||
- **Build from Source** - For development and customization
|
||
|
||
See our [installation guide](https://usememos.com/docs/installation) for detailed instructions.
|
||
|
||
## Contributing
|
||
|
||
We welcome contributions of all kinds! Whether you're fixing bugs, adding features, improving documentation, or helping with translations — every contribution matters.
|
||
|
||
**Ways to contribute:**
|
||
|
||
- 🐛 [Report bugs](https://github.com/usememos/memos/issues/new?template=bug_report.md)
|
||
- 💡 [Suggest features](https://github.com/usememos/memos/issues/new?template=feature_request.md)
|
||
- 🔧 [Submit pull requests](https://github.com/usememos/memos/pulls)
|
||
- 📖 [Improve documentation](https://github.com/usememos/memos/tree/main/docs)
|
||
- 🌍 [Help with translations](https://github.com/usememos/memos/tree/main/web/src/locales)
|
||
|
||
## Sponsors
|
||
|
||
Love Memos? [Sponsor us on GitHub](https://github.com/sponsors/usememos) to help keep the project growing!
|
||
|
||
## Star History
|
||
|
||
[](https://star-history.com/#usememos/memos&Date)
|
||
|
||
## License
|
||
|
||
Memos is open-source software licensed under the [MIT License](LICENSE).
|
||
|
||
## Privacy Policy
|
||
|
||
Memos is built with privacy as a core principle. As a self-hosted application, all your data stays on your infrastructure. There is no telemetry, no tracking, and no data collection. See our [Privacy Policy](https://usememos.com/privacy) for details.
|
||
|
||
---
|
||
|
||
**[Website](https://usememos.com)** • **[Documentation](https://usememos.com/docs)** • **[Demo](https://demo.usememos.com/)** • **[Discord](https://discord.gg/tfPJa4UmAv)** • **[X/Twitter](https://x.com/usememos)**
|
||
|
||
<a href="https://vercel.com/oss">
|
||
<img alt="Vercel OSS Program" src="https://vercel.com/oss/program-badge.svg" />
|
||
</a>
|