diff --git a/docs/.vitepress/theme/components/Supported.vue b/docs/.vitepress/theme/components/Supported.vue
new file mode 100644
index 00000000..c7189a57
--- /dev/null
+++ b/docs/.vitepress/theme/components/Supported.vue
@@ -0,0 +1,37 @@
+
+
+
+
+
diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
index 00564053..c8f424b8 100644
--- a/docs/.vitepress/theme/index.ts
+++ b/docs/.vitepress/theme/index.ts
@@ -8,6 +8,7 @@ import HeroVideo from "./components/HeroVideo.vue";
import BuyMeCoffee from "./components/BuyMeCoffee.vue";
import Stats from "./components/Stats.vue";
import Banner from "./components/Banner.vue";
+import Supported from "./components/Supported.vue";
export default {
...DefaultTheme,
@@ -16,7 +17,8 @@ export default {
"home-hero-image": () => h(HeroVideo),
"sidebar-nav-after": () => h(BuyMeCoffee),
"home-hero-actions-after": () => h(Stats),
- "layout-top": () => h(Banner),
+ // "layout-top": () => h(Banner),
+ "home-hero-after": () => h(Supported),
});
},
enhanceApp(ctx) {
diff --git a/docs/components.d.ts b/docs/components.d.ts
index 66404646..6fd769c5 100644
--- a/docs/components.d.ts
+++ b/docs/components.d.ts
@@ -2,6 +2,7 @@
// @ts-nocheck
// Generated by unplugin-vue-components
// Read more: https://github.com/vuejs/core/pull/3399
+// biome-ignore lint: disable
export {}
/* prettier-ignore */
@@ -14,5 +15,6 @@ declare module 'vue' {
RouterLink: typeof import('vue-router')['RouterLink']
RouterView: typeof import('vue-router')['RouterView']
Stats: typeof import('./.vitepress/theme/components/Stats.vue')['default']
+ Supported: typeof import('./.vitepress/theme/components/Supported.vue')['default']
}
}
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
index 0f34e4db..8a95f885 100644
--- a/docs/guide/getting-started.md
+++ b/docs/guide/getting-started.md
@@ -4,9 +4,12 @@ title: Getting Started
# Getting Started
-Dozzle supports multiple ways to run the application. You can run it using Docker CLI, Docker Compose, or in Swarm. The following sections will guide you through the process of setting up Dozzle.
+Dozzle supports multiple ways to run the application. You can run it using Docker CLI, Docker Compose, Swarm, or Kubernetes. The following sections will guide you through the process of setting up Dozzle.
-## Running with Docker
+> [!TIP]
+> If Docker Hub is blocked in your network, you can use the [GitHub Container Registry](https://ghcr.io/amir20/dozzle:latest) to pull the image. Use `ghcr.io/amir20/dozzle:latest` instead of `amir20/dozzle:latest`.
+
+## Standalone Docker
The easiest way to set up Dozzle is to use the CLI and mount `docker.sock` file. This file is usually located at `/var/run/docker.sock` and can be mounted with the `--volume` flag. You also need to expose the port to view Dozzle. By default, Dozzle listens on port 8080, but you can change the external port using `-p`. You can also run using compose or as a service in Swarm.
@@ -27,6 +30,14 @@ services:
- 8080:8080
```
+:::
+
+Dozzle also supports connecting to remote agents to monitor multiple Docker hosts. See [agent](/guide/agent) to learn more.
+
+## Docker Swarm
+
+Dozzle supports running in Swarm mode by deploying it on every node. To run Dozzle in Swarm mode, you can use the following configuration:
+
```yaml [dozzle-stack.yml]
# Run with docker stack deploy -c dozzle-stack.yml
services:
@@ -47,6 +58,18 @@ networks:
driver: overlay
```
+Then you can deploy the stack using the following command:
+
+```bash
+docker stack deploy -c dozzle-stack.yml
+```
+
+See [swarm mode](/guide/swarm-mode) for more information.
+
+## K8s
+
+Dozzle supports running in Kubernetes. It only needs to be deployed on one node within the cluster.
+
```yaml [k8s-dozzle.yml]
# rbac.yaml
apiVersion: v1
@@ -107,9 +130,10 @@ spec:
value: "k8s"
```
-:::
+Then apply the configuration using the following command:
-See [swarm mode](/guide/swarm-mode) for more information on running Dozzle in Swarm and [Kubernetes](/guide/k8s) for running Dozzle in Kubernetes.
+```bash
+kubectl apply -f k8s-dozzle.yml
+```
-> [!TIP]
-> If Docker Hub is blocked in your network, you can use the [GitHub Container Registry](https://ghcr.io/amir20/dozzle:latest) to pull the image. Use `ghcr.io/amir20/dozzle:latest` instead of `amir20/dozzle:latest`.
+See [Kubernetes mode](/guide/k8s) for more information.
diff --git a/docs/index.md b/docs/index.md
index 65080b25..9c9af264 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -6,7 +6,7 @@ title: Home
hero:
name: "Dozzle"
- tagline: Real-time logging and monitoring for Docker in the browser
+ tagline: Simple Container Monitoring and Logging
actions:
- theme: brand
text: Get Started