usememos/memos: An open source, lightweight note-taking service. Easily capture and share your great thoughts.

mirror of https://github.com/usememos/memos.git synced 2024-09-20 06:25:56 +08:00

An open source, lightweight note-taking service. Easily capture and share your great thoughts.

docker free go markdown memo microblog note-taking react self-hosted social-network sqlite starred-repo starred-usememos-repo

Go to file

boojack bd9003c24b chore: update readme (#1047 )		2023-02-08 08:51:36 +08:00
.github	chore: update code owners (#1041 )	2023-02-07 20:08:51 +08:00
.vscode	chore: update config files	2022-08-25 20:44:17 +08:00
api	feat: update Traditional Chinese translation (#994 )	2023-01-29 09:41:56 +08:00
bin/server	feat: graceful shutdown server (#1016 )	2023-02-03 10:30:18 +08:00
common	feat: graceful shutdown server (#1016 )	2023-02-03 10:30:18 +08:00
docs	chore: update dev config (#857 )	2022-12-25 10:39:45 +08:00
plugin	chore: update activity metrics (#908 )	2023-01-05 20:56:50 +08:00
resources	chore: update demo image (#672 )	2022-12-04 20:43:46 +08:00
scripts	feat: graceful shutdown server (#1016 )	2023-02-03 10:30:18 +08:00
server	feat: graceful shutdown server (#1016 )	2023-02-03 10:30:18 +08:00
store	chore: update seed data (#1042 )	2023-02-07 20:35:32 +08:00
web	chore: update readme (#1047 )	2023-02-08 08:51:36 +08:00
.dockerignore	chore: update resource dialog style (#982 )	2023-01-21 08:46:49 +08:00
.gitignore	chore: add .vscode to gitignore (#596 )	2022-11-27 07:56:19 +08:00
.golangci.yaml	chore: update golangci-lint config (#168 )	2022-08-24 22:03:07 +08:00
CODEOWNERS	chore: update readme (#1047 )	2023-02-08 08:51:36 +08:00
docker-compose.uffizzi.yml	feat: add Uffizzi Integration (#655 )	2022-12-08 23:45:23 +08:00
docker-compose.yaml	chore: update readme	2022-09-03 18:46:16 +08:00
Dockerfile	chore: upgrade version to `0.10.1` (#949 )	2023-01-14 08:00:07 +08:00
go.mod	feat: graceful shutdown server (#1016 )	2023-02-03 10:30:18 +08:00
go.sum	feat: graceful shutdown server (#1016 )	2023-02-03 10:30:18 +08:00
LICENSE	feat: responsive view (#75 )	2022-06-19 11:32:49 +08:00
README.md	chore: update readme (#1047 )	2023-02-08 08:51:36 +08:00
SECURITY.md	chore: add `SECURITY.md` (#562 )	2022-11-25 09:05:52 +08:00

README.md

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.