From f2243634cd29860900cefc439466ef2bc76cc780 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Thu, 14 Nov 2024 11:33:55 +0800 Subject: [PATCH] Update docs and docker-compose --- Docker/dist/docker-compose.yaml | 2 ++ guides/users-guide/creating-a-new-monitor.md | 17 ++++++++------- guides/users-guide/quickstart.md | 22 ++++++++++++++++++++ 3 files changed, 33 insertions(+), 8 deletions(-) diff --git a/Docker/dist/docker-compose.yaml b/Docker/dist/docker-compose.yaml index c62fb2ea6..6d3faaf7f 100644 --- a/Docker/dist/docker-compose.yaml +++ b/Docker/dist/docker-compose.yaml @@ -18,6 +18,8 @@ services: environment: - DB_CONNECTION_STRING=mongodb://mongodb:27017/uptime_db - REDIS_HOST=redis + # volumes: + # - /var/run/docker.sock:/var/run/docker.sock:ro redis: image: bluewaveuptime/uptime_redis:latest ports: diff --git a/guides/users-guide/creating-a-new-monitor.md b/guides/users-guide/creating-a-new-monitor.md index 5784d1f41..0135c0b81 100644 --- a/guides/users-guide/creating-a-new-monitor.md +++ b/guides/users-guide/creating-a-new-monitor.md @@ -8,24 +8,25 @@ Creating a new monitor involves a few steps, mentioned below. ### General settings -* **URL to monitor:** Enter the full URL of the website or service you want to monitor. -* **Display name:** Optionally, provide a custom name for your monitor. This helps identify it easily in your dashboard. +- **URL to monitor:** Enter the full URL of the website or service you want to monitor. +- **Display name:** Optionally, provide a custom name for your monitor. This helps identify it easily in your dashboard. ### Checks to perform -* **Website monitoring:** This option uses HTTP(s) to monitor your website or API endpoint. You can choose between HTTPS and HTTP protocols. -* **Ping monitoring:** Checks whether your server is available. This option is currently unselected. +- **Website monitoring:** This option uses HTTP(s) to monitor your website or API endpoint. You can choose between HTTPS and HTTP protocols. +- **Ping monitoring:** Checks whether your server is available. This option is currently unselected. +- **Docker monitoring:** Checks whether a Docker container is running ### Incident notifications When there's a new incident, you can choose how to be notified: -* Notify via SMS (coming soon) -* Notify via email (to the email address you logged in with) -* Notify via email to multiple addresses (coming soon) +- Notify via SMS (coming soon) +- Notify via email (to the email address you logged in with) +- Notify via email to multiple addresses (coming soon) ### Advanced settings -* **Check frequency:** Set how often the system should check your monitor. The current setting is 1 minute. +- **Check frequency:** Set how often the system should check your monitor. The current setting is 1 minute. After configuring all settings, click the "Create monitor" button at the bottom right to set up your new monitor. diff --git a/guides/users-guide/quickstart.md b/guides/users-guide/quickstart.md index 55e23f286..665062bf3 100644 --- a/guides/users-guide/quickstart.md +++ b/guides/users-guide/quickstart.md @@ -10,6 +10,17 @@ icon: sign-posts-wrench 2. Run `docker compose up` to start the application 3. Now the application is running at `http://localhost` +##### Optional Config: + +- If you want to monitor Docker containers, uncomment this line in `docker-compose.yaml`: + +``` + # volumes: + # - /var/run/docker.sock:/var/run/docker.sock:ro +``` + +This gives the app access to your docker daemon via unix socket, please be aware of what you are doing. + --- ## Quickstart for users (remote server) @@ -19,6 +30,17 @@ icon: sign-posts-wrench 3. Run `docker compose up` to start the application 4. Now the application is running at `http://` +##### Optional Config: + +- If you want to monitor Docker containers, uncomment this line in `docker-compose.yaml`: + +``` + # volumes: + # - /var/run/docker.sock:/var/run/docker.sock:ro +``` + +This gives the app access to your docker daemon via unix socket, please be aware of what you are doing. + --- ## Quickstart for developers