memos/README.md at bd9003c24baeea4a4ab342c042046a24b664a9df

usememos/memos

Fork 0

mirror of https://github.com/usememos/memos.git synced 2024-11-10 08:52:22 +08:00

boojack bd9003c24b

chore: update readme (#1047 )

2023-02-08 08:51:36 +08:00

3.1 KiB

Raw Blame History

Live Demo • Discuss in Telegram / Discord 🏂

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

~/.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

Example docker compose YAML file: docker-compose.yaml.

You can upgrade memos with the following command.

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

Other guides

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.