memos

command module
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 24, 2023 License: MIT Imports: 2 Imported by: 0

README ยถ

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

Documentation ยถ

The Go Gopher

There is no documentation for this package.

Directories ยถ

Path Synopsis
log
Package log implements a simple logging package.
Package log implements a simple logging package.
plugin
http_getter
getter is using to get resources from url.
getter is using to get resources from url.
idp
idp/oauth2
Package oauth2 is the plugin for OAuth2 Identity Provider.
Package oauth2 is the plugin for OAuth2 Identity Provider.
db

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL