mirror of
https://github.com/usememos/memos.git
synced 2024-12-21 10:11:42 +03:00
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
<p align="center"><a href="https://usememos.com"><img height="64px" src="https://raw.githubusercontent.com/usememos/memos/main/resources/logo-full.webp" alt="✍️ memos" /></a></p>
|
|
|
|
<p align="center">An open source, self-hosted knowledge base that works with a SQLite db file.</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/usememos/memos/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/usememos/memos" /></a>
|
|
<a href="https://hub.docker.com/r/neosmemo/memos"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/neosmemo/memos.svg" /></a>
|
|
<img alt="Go report" src="https://goreportcard.com/badge/github.com/usememos/memos" />
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://demo.usememos.com/">Live Demo</a> •
|
|
<a href="https://t.me/+-_tNF1k70UU4ZTc9">Discuss in Telegram 👾</a>
|
|
</p>
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- 🦄 Fully open source;
|
|
- 📜 Writing in plain textarea without any burden,
|
|
- and support some useful markdown syntax 💪.
|
|
- 🌄 Share the memo in a pretty image or personal page like Twitter;
|
|
- 🚀 Fast self-hosting with `Docker`;
|
|
- 🤠 Pleasant UI and UX;
|
|
|
|
## Deploy with Docker
|
|
|
|
### Docker Run
|
|
|
|
```docker
|
|
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:latest
|
|
```
|
|
|
|
Memos should be running at [http://localhost:5230](http://localhost:5230). If the `~/.memos/` does not have a `memos_prod.db` file, then memos will auto generate it.
|
|
|
|
### Docker Compose
|
|
|
|
See more in the example [`docker-compose.yaml`](./docker-compose.yaml) file.
|
|
|
|
If you want to upgrade the version of memos, use the following command.
|
|
|
|
```sh
|
|
docker-compose down && docker image rm neosmemo/memos:latest && docker-compose up -d
|
|
```
|
|
|
|
## Contributing
|
|
|
|
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. 🥰
|
|
|
|
Gets more about [development guide](https://github.com/usememos/memos/tree/main/docs/development.md).
|
|
|
|
## Star history
|
|
|
|
[](https://star-history.com/#usememos/memos&Date)
|