diff --git a/README.md b/README.md
index a0f14ab..e5b8615 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
# Dockge
-A fancy, easy-to-use and reactive docker `compose.yaml` stack oriented manager.
+A fancy, easy-to-use and reactive docker `compose.yaml` stack-oriented manager.
@@ -21,23 +21,31 @@ A fancy, easy-to-use and reactive docker `compose.yaml` stack oriented manager.
## 🔧 How to Install
+Requirements:
+- [Docker CE](https://docs.docker.com/engine/install/) 20+ is recommended
+- [Docker Compose V2](https://docs.docker.com/compose/install/linux/)
+- OS:
+ - As long as you can run Docker CE, it should be fine, but:
+ - Debian/Raspbian Buster or lower is not supported, please upgrade to Bullseye
+- Arch: armv7, arm64, amd64 (a.k.a x86_64)
+
### Basic
Default stacks directory is `/opt/stacks`.
```
-# Create a directory that stores your stacks
-mkdir -p /opt/stacks
-
-# Create a directory that stores dockge's compose.yaml
-mkdir -p /opt/dockge
+# Create a directory that stores your stacks and stores dockge's compose.yaml
+mkdir -p /opt/stacks /opt/dockge
cd /opt/dockge
# Download the compose.yaml
-wget https://raw.githubusercontent.com/louislam/dockge/master/compose.yaml
+curl https://raw.githubusercontent.com/louislam/dockge/master/compose.yaml --output compose.yaml
# Start Server
-docker-compose up -d
+docker compose up -d
+
+# If you are using docker-compose V1
+# docker-compose up -d
```
### Advanced
@@ -66,6 +74,13 @@ services:
- DOCKGE_STACKS_DIR=/my-stacks
```
+## How to Update
+
+```bash
+cd /opt/stacks
+docker compose pull
+docker compose up -d
+```
## Motivations
@@ -89,6 +104,15 @@ If you are not comfortable with the pronunciation, you can call it `Dockage`
The main objective of Dockge is that try to use docker `compose.yaml` for everything. If you want to manage a single container, you can just use Portainer or Docker CLI.
+#### Can I manage existing stacks?
+
+Yes, you can. However, you need to move your compose file into the stacks directory:
+
+1. Stop your stack
+2. Move your compose file into `/opt/stacks//compose.yaml`
+3. In Dockge, click the " Scan Stacks Folder" button in the top-right corner's dropdown menu
+4. Now you should see your stack in the list
+
## More Ideas?
- Stats
diff --git a/package.json b/package.json
index edd7637..3175afc 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "dockge",
- "version": "0.0.1",
+ "version": "1.0.0",
"type": "module",
"scripts": {
"fmt": "eslint \"**/*.{ts,vue}\" --fix",
@@ -10,7 +10,7 @@
"dev:frontend": "cross-env NODE_ENV=development vite --host --config ./frontend/vite.config.ts",
"build:frontend": "vite build --config ./frontend/vite.config.ts",
"build:docker-base": "docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/dockge:base -f ./docker/Base.Dockerfile . --push",
- "build:docker": "pnpm run build:frontend && docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/dockge:latest -f ./docker/Dockerfile . --push",
+ "build:docker": "pnpm run build:frontend && docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/dockge:latest -t louislam/dockge:1 -t louislam/dockge:1.0.0 -f ./docker/Dockerfile . --push",
"build:docker-nightly": "pnpm run build:frontend && docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/dockge:nightly --target nightly -f ./docker/Dockerfile . --push",
"start-docker": "docker run --rm -p 5001:5001 --name dockge louislam/dockge:latest",
"mark-as-nightly": "tsx ./extra/mark-as-nightly.ts"