README
¶
Memos - Open Source, Self-hosted, Your Notes, Your Way
An open-source, self-hosted note-taking solution designed for seamless deployment and multi-platform access. Experience effortless plain text writing with pain-free, complemented by robust Markdown syntax support for enhanced formatting.
Home Page • Blogs • Docs • Live Demo
Main Features
- Privacy First 🏠: Take control of your data. All runtime data is securely stored in your local database.
- Create at Speed ✍️: Save content as plain text for quick access, with Markdown support for fast formatting and easy sharing.
- Lightweight but Powerful 🤲: Built with Go, React.js, and a compact architecture, our application delivers powerful performance in a lightweight package.
- Customizable 🧩: Easily customize your server name, icon, description, system style, and execution scripts to make it uniquely yours.
- Open Source 🦦: Memos embraces the future of open source, with all code available on GitHub for transparency and collaboration.
- Free to Use 💸: Enjoy all features completely free, with no charges ever for any content.
Deploy with Docker in seconds
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:stable
[!NOTE] This command is only applicable for Unix/Linux systems. For Windows, please refer to the detailed documentation.
The
~/.memos/directory will be used as the data directory on your local machine, while/var/opt/memosis the directory of the volume in Docker and should not be modified.
Learn more about other installation methods.
Contribution
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. We greatly appreciate any contributions you make. Thank you for being a part of our community! 🥰
Sponsorship
If you find Memos helpful, please consider sponsoring us. Your support will help us to continue developing and maintaining the project.
❤️ Thanks to the following sponsors and backers: yourselfhosted, Burning_Wipf, ...see more.
Star history
Other Projects
- Slash: An open source, self-hosted bookmarks and link sharing platform. Save and share your links very easily.
- Gomark: A markdown parser written in Go for Memos. And its WebAssembly version is also available.
Directories
¶
| Path | Synopsis |
|---|---|
|
bin
|
|
|
internal
|
|
|
plugin
|
|
|
httpgetter
Package httpgetter is using to get resources from url.
|
Package httpgetter is using to get resources from url. |
|
idp/oauth2
Package oauth2 is the plugin for OAuth2 Identity Provider.
|
Package oauth2 is the plugin for OAuth2 Identity Provider. |
|
proto
|
|
|
gen/api/v1
Package apiv1 is a reverse proxy.
|
Package apiv1 is a reverse proxy. |
|
runner/version
Package version provides a runner to check the latest version of the application.
|
Package version provides a runner to check the latest version of the application. |