Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
louislam authored Nov 11, 2023
1 parent b12056a commit c5d3b23
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<img src="https://github.com/louislam/dockge/assets/1336778/cc071864-592e-4909-b73a-343a57494002" width=300 />


## 🔧 How to Install

Expand All @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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`?

Expand Down

0 comments on commit c5d3b23

Please sign in to comment.