Skip to content

armgit / memos

Public Imported from GitHub
0

Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.

chore: update readme

Steven43575e6f54f3
diff --git a/README.md b/README.md
index b1510adac..ebf6f374d 100644
--- a/README.md
+++ b/README.md
@@ -26,27 +26,17 @@
## Deploy with Docker
-#### Docker Run
+### Docker Run
```docker
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:latest
```
-#### Docker Compose
+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.
-```
-version: "3.0"
-services:
- memos:
- image: neosmemo/memos:latest
- container_name: memos
- volumes:
- - ~/.memos/:/var/opt/memos
- ports:
- - 5230:5230
-```
+### Docker Compose
-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.
+See [the example `docker-compose.yaml`](./docker-compose.yaml) file.
## Development
diff --git a/docker-compose.yml b/docker-compose.yaml
similarity index 85%
rename from docker-compose.yml
rename to docker-compose.yaml
index fa8e71748..2d4a66ded 100644
--- a/docker-compose.yml
+++ b/docker-compose.yaml
@@ -7,4 +7,3 @@ services:
- ~/.memos/:/var/opt/memos
ports:
- 5230:5230
- restart: unless-stopped