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-21 06:55:55 +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 b19c3c6db3 feat: update renderer in list (#935 )		2023-01-12 08:52:57 +08:00
.github	chore: update middleware skipper (#887 )	2023-01-01 23:26:21 +08:00
.vscode	chore: update config files	2022-08-25 20:44:17 +08:00
api	chore: update memo create activity (#903 )	2023-01-03 23:49:11 +08:00
bin/server	feat: persistent session name (#902 )	2023-01-03 23:05:42 +08:00
common	chore: update memo list api (#350 )	2022-10-27 14:02:42 +00: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	chore: update build folder	2022-08-27 08:57:05 +08:00
server	feat: update memo resources style (#933 )	2023-01-12 00:00:44 +08:00
store	fix: version compare (#916 )	2023-01-07 13:58:42 +08:00
web	feat: update renderer in list (#935 )	2023-01-12 08:52:57 +08:00
.dockerignore	feat: add build&push docker image action	2021-12-14 10:17:24 +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	2022-03-06 12:07:58 +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: restore dockerfile (#841 )	2022-12-23 22:12:41 +08:00
go.mod	fix: version compare (#916 )	2023-01-07 13:58:42 +08:00
go.sum	fix: version compare (#916 )	2023-01-07 13:58:42 +08:00
LICENSE	feat: responsive view (#75 )	2022-06-19 11:32:49 +08:00
README.md	chore: add `User stories` section to readme (#932 )	2023-01-11 09:21:52 +08:00
SECURITY.md	chore: add `SECURITY.md` (#562 )	2022-11-25 09:05:52 +08:00

README.md

An open-source, self-hosted memo hub with knowledge management and socialization.

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

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

If the ~/.memos/ does not have a memos_prod.db file, then memos will auto generate it. Memos will be running at http://localhost:5230.

Docker Compose

Example Compose YAML file: docker-compose.yaml.

If you want to upgrade the version of memos, use 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.