memos

mirror of https://github.com/usememos/memos.git synced 2024-11-28 23:04:57 +03:00

A lightweight, self-hosted memo hub. Open Source and Free forever.

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

Go to file

boojack c79e51a91b chore: update readme (#606 )		2022-11-27 16:04:35 +08:00
.github	chore(revert): update test image platforms (#576 )	2022-11-25 22:08:43 +08:00
.vscode	chore: update config files	2022-08-25 20:44:17 +08:00
api	chore: fix some typos (#587 )	2022-11-26 06:23:29 +00:00
bin/server	chore: disable metrics collector (#580 )	2022-11-26 09:23:38 +08:00
common	chore: update memo list api (#350 )	2022-10-27 14:02:42 +00:00
docs	chore: update docs	2022-09-09 00:32:01 +08:00
plugin	chore: update tests (#572 )	2022-11-25 21:51:53 +08:00
resources	chore: update resources	2022-09-03 18:41:54 +08:00
scripts	chore: update build folder	2022-08-27 08:57:05 +08:00
server	chore: fix some typos (#587 )	2022-11-26 06:23:29 +00:00
store	fix: initial database schema (#601 )	2022-11-27 08:52:43 +08:00
web	chore: show content image (#602 )	2022-11-27 09:01:19 +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.yaml	chore: update readme	2022-09-03 18:46:16 +08:00
Dockerfile	chore: update dependencies version (#491 )	2022-11-19 14:51:28 +08:00
go.mod	feat: add crawler plugin (#492 )	2022-11-19 16:58:55 +08:00
go.sum	feat: add crawler plugin (#492 )	2022-11-19 16:58:55 +08:00
LICENSE	feat: responsive view (#75 )	2022-06-19 11:32:49 +08:00
README.md	chore: update readme (#606 )	2022-11-27 16:04:35 +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

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

Contribute

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰

See more in development guide.

Products made by Community

Moe Memos - Third party client for iOS and Android
lmm214/memos-bber - Chrome extension
Rabithua/memos_wmp - Wechat miniprogram
qazxcdswe123/telegramMemoBot - Telegram bot

License

This project is open source and available under the MIT License.