memos/README.md

Live Demo • Discuss in Telegram / Discord 🏂

Features

• 🦄 Open source and free forever;
• 🚀 Support for self-hosting with Docker in seconds;
• 📜 Plain textarea first and support some useful Markdown syntax;
• 👥 Set memo private or public to others;
• 🧑‍💻 RESTful API for self-service.

Deploy with Docker in seconds

Docker Run

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

~/.memos/ will be used as the data directory in your machine. And /var/opt/memos is the directory of the volume in docker and should not be modified.

Docker Compose

Example docker compose YAML file: docker-compose.yaml.

You can upgrade memos with the following command.

docker-compose down && docker image rm neosmemo/memos:latest && docker-compose up -d

Other guides

• Deploy on render.com
• Deploy on fly.io

Contribute

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰

See more in development guide.

Products made by Community

• Moe Memos - Third party client for iOS and Android
• lmm214/memos-bber - Chrome extension
• Rabithua/memos_wmp - WeChat MiniProgram
• qazxcdswe123/telegramMemoBot - Telegram bot
• eallion/memos.top - A static page rendered with the Memos API
• eindex/logseq-memos-sync - A Logseq plugin

User stories

• Memos - A Twitter Like Notes App You can Self Host

Join the community to build memos together!

License

MIT License.

Star history