From c5d3b23af2f4029a59dccda0114ad5d304eca2e6 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Sun, 12 Nov 2023 01:55:11 +0800 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f0cb622..6099c3d 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,10 @@ A fancy, easy-to-use and reactive docker `compose.yaml` stack-oriented manager. - Easy-to-use & fancy UI - If you love Uptime Kuma's UI/UX, you will love this too - Convert `docker run ...` commands into `compose.yaml` +- File based structure + - Dockge won't kidnap your compose files, they stored on your drive as usual. You can interact with them using normal `docker compose` commands + + ## 🔧 How to Install @@ -33,7 +37,8 @@ Requirements: ### Basic -Default stacks directory is `/opt/stacks`. +- Default Stacks Directory: `/opt/stacks` +- Default Port: 5001 ``` # Create a directory that stores your stacks and stores dockge's compose.yaml @@ -50,6 +55,8 @@ docker compose up -d # docker-compose up -d ``` +Dockge is now running on http://localhost:5001 + ### Advanced If you want to store your stacks in another directory, you can change the `DOCKGE_STACKS_DIR` environment variable and volumes. @@ -113,7 +120,7 @@ If you love this project, please consider giving this project a ⭐. The naming idea was coming from Twitch emotes like `sadge`, `bedge` or `wokege`. They are all ending with `-ge`. -If you are not comfortable with the pronunciation, you can call it `Dockage` +If you are not comfortable with the pronunciation, you can call it `Dockage`. #### Can I manage a single container without `compose.yaml`?