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
boojack dd625d8edc
chore: update links reference (#1243)
2 years ago
.github chore(build): anchor setup-buildx-action@v2 to version v0.9.1 (#1089) 2 years ago
.vscode feat(mode): add demo mode (#1121) 2 years ago
api feat: add support for s3 path (#1233) 2 years ago
cmd chore: update code structure (#1139) 2 years ago
common feat: implement sign in with SSO (#1119) 2 years ago
doc docs: create CustomThemes.md (#1210) 2 years ago
docs
plugin feat: add support for s3 path (#1233) 2 years ago
resources
scripts chore: update code structure (#1139) 2 years ago
server feat: add support for s3 path (#1233) 2 years ago
store feat: add resource visibility to user setting (#1190) 2 years ago
web chore: update links reference (#1243) 2 years ago
.dockerignore
.gitignore
.golangci.yaml
CODEOWNERS
Dockerfile chore: update code structure (#1139) 2 years ago
LICENSE
README.md chore: update readme with weblate badge (#1126) 2 years ago
SECURITY.md
docker-compose.uffizzi.yml feat(mode): add demo mode (#1121) 2 years ago
docker-compose.yaml
go.mod fix: correct comments for exported functions and variables (#1158) 2 years ago
go.sum chore: update code structure (#1139) 2 years ago
main.go chore: update code structure (#1139) 2 years ago

README.md

✍️ 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