A lightweight, self-hosted memo hub. Open Source and Free forever.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Ruihang Xia e46f77681d
chore(build): anchor setup-buildx-action@v2 to version v0.9.1 (#1089)
Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
2 years ago
.github chore(build): anchor setup-buildx-action@v2 to version v0.9.1 (#1089) 2 years ago
.vscode feat: storage service frontend (#1088) 2 years ago
api feat: storage service frontend (#1088) 2 years ago
bin/server feat: graceful shutdown server (#1016) 2 years ago
common feat: graceful shutdown server (#1016) 2 years ago
docs chore: update dev config (#857) 2 years ago
plugin feat: storage service backend (#1086) 2 years ago
resources chore: update readme with dark mode demo (#1049) 2 years ago
scripts feat: graceful shutdown server (#1016) 2 years ago
server feat: storage service frontend (#1088) 2 years ago
store feat: storage service frontend (#1088) 2 years ago
web chore: update storage components (#1091) 2 years ago
.dockerignore chore: update resource dialog style (#982) 2 years ago
.gitignore chore: setup project workspace for better DX (#1048) 2 years ago
.golangci.yaml chore: update golangci-lint config (#168) 3 years ago
CODEOWNERS chore: update readme (#1047) 2 years ago
Dockerfile chore: upgrade version to `0.10.1` (#949) 2 years ago
LICENSE
README.md chore: make README more comprehensive (#1065) 2 years ago
SECURITY.md chore: add `SECURITY.md` (#562) 2 years ago
docker-compose.uffizzi.yml chore: update signup api (#1067) 2 years ago
docker-compose.yaml chore: update readme 3 years ago
go.mod feat: storage service backend (#1086) 2 years ago
go.sum feat: storage service backend (#1086) 2 years ago

README.md

✍️ memos

GitHub stars Docker pull 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