Skip to content

Commit 2cf5476

Browse files
Update README.md
1 parent bb8fae2 commit 2cf5476

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@
4141

4242
## Features
4343

44-
- Start Docker containers via simple HTTP requests.
45-
- Automatically stop inactive containers.
44+
- Start Docker containers via **simple HTTP requests**.
45+
- Automatically **stop inactive containers**.
4646
- Integrates with [WoL-Redirect](https://github.com/codeshelldev/wol-redirect) for a graphical interface.
47-
- Provides real-time process updates via WebSocket.
47+
- Provides real-time process updates via **WebSocket**.
4848

4949
## Installation
5050

@@ -71,8 +71,6 @@ services:
7171
docker compose up -d
7272
```
7373

74-
3. Optionally, combine with [WoL-Redirect](https://github.com/codeshelldev/wol-redirect) for a web interface.
75-
7674
## Setup
7775

7876
### Auto Stop
@@ -87,6 +85,9 @@ http://wol-dockerized:7777/activity
8785
> This is currently not straightforward. You cannot just redirect to `/activity`. You need to use a _forward auth_ middleware.
8886
> Currently, `wol-dockerized` will respond with `200 OK`.
8987
88+
> [!TIP]
89+
> By default auto stop is enabled to disable this feature add `wol.autostop=false` to the labels.
90+
9091
### Traefik Integration
9192

9293
See [Traefik Forward Auth Middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) for details on how to integrate.
@@ -135,7 +136,7 @@ The WebSocket sends structured updates during the startup sequence:
135136
### `QUERY_PATTERN`
136137

137138
Matches an incoming request to the correct container(s) by using components extracted from the real URL.
138-
These components are made available as variables:
139+
These components are made available as **variables**:
139140

140141
- `HOSTNAME`, `HOST`, `PORT`, `PROTOCOL`, `PATH`
141142

@@ -150,12 +151,12 @@ The query pattern `{HOSTNAME}{HOSTNAME}` results in `sub.domain.comsub.domain.co
150151

151152
### `MONITOR_INTERVAL`
152153

153-
Interval in seconds for inactivity monitoring.
154+
Interval in seconds for **inactivity monitoring**.
154155

155156
### `INACTIVITY_THRESHOLD`
156157

157-
Duration (in seconds) a container can remain idle without receiving activity reports.
158-
If no requests are forwarded to the `/activity` endpoint for longer than this threshold, the container is marked as idle and may be stopped automatically.
158+
Duration (in seconds) a container can remain **idle** without receiving activity reports.
159+
If no requests are forwarded to the `/activity` endpoint for longer than this threshold, the container is marked as idle and **may be stopped automatically**.
159160

160161
## Contributing
161162

0 commit comments

Comments
 (0)