1
1
mirror of https://github.com/usememos/memos.git synced 2024-12-27 13:23:39 +03:00
memos/README.md

4.0 KiB

✍️ memos

GitHub stars Docker pull Translation status Discord

Live Demo • Discuss in Telegram / Discord

demo

demo-dark

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
  • 📋 Embed memos on other sites using iframe
  • #️⃣ Hashtags for organizing memos
  • 📆 Interactive calendar view
  • 💾 Easy data migration and backups

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

  • Provided docker compose YAML file: docker-compose.yaml.

  • You can upgrade to the latest version memos with:

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

Other installation methods

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. 🥰

Learn more about contributing in development guide.

Products made by our Community

User stories

Join the community to build memos together!

Acknowledgements

  • Thanks Uffizzi for sponsoring preview environments for PRs.

License

MIT License

Star history

Star History Chart