A lightweight, self-hosted memo hub. Open Source and Free forever.
Go to file
helaxious 62f53888ba
feat: update docker command description (#893) (#900)
* Add a line on README to help prevent a mistake (#893)

* Update README.md

Co-authored-by: boojack <stevenlgtm@gmail.com>

Co-authored-by: boojack <stevenlgtm@gmail.com>
2023-01-03 22:40:53 +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 server activity (#898) 2023-01-03 20:05:37 +08:00
bin/server chore: update server activity (#898) 2023-01-03 20:05:37 +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 tests (#572) 2022-11-25 21:51:53 +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 chore: update server activity (#898) 2023-01-03 20:05:37 +08:00
store feat: add activity table (#888) 2023-01-01 23:55:02 +08:00
web feat: add Italian Translation (#890) 2023-01-02 09:41:39 +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 feat: add activity table (#888) 2023-01-01 23:55:02 +08:00
go.sum feat: add activity table (#888) 2023-01-01 23:55:02 +08:00
LICENSE feat: responsive view (#75) 2022-06-19 11:32:49 +08:00
README.md feat: update docker command description (#893) (#900) 2023-01-03 22:40:53 +08:00
SECURITY.md chore: add SECURITY.md (#562) 2022-11-25 09:05:52 +08:00

✍️ memos

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

GitHub stars Docker pull Discord

Live Demo • Discuss in Telegram / Discord 🏂

demo

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

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.

Products made by Community

Join the community to build memos together!

License

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

Star history

Star History Chart