memos/README.md

3.1 KiB

✍️ memos

An open-source, self-hosted memo hub with knowledge management and socialization.

GitHub stars Docker pull Go report

Live Demo • Discuss in Telegram / Discord 🏂

demo

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

If the ~/.memos/ does not have a memos_prod.db file, then memos will auto generate it. Memos will be running at http://localhost:5230.

Docker Compose

Example Compose YAML file: docker-compose.yaml.

If you want to upgrade the version of memos, use the following command.

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

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

Join the community to build memos together!

License

This project is open source and available under the MIT License.

Star history

Star History Chart