Skip to content

Commit bb8fae2

Browse files
committed
improve formatting and highlighting
1 parent 6432c94 commit bb8fae2

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

.github/templates/README.template.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

@@ -60,8 +60,6 @@
6060
docker compose up -d
6161
```
6262

63-
3. Optionally, combine with [WoL-Redirect](https://github.com/codeshelldev/wol-redirect) for a web interface.
64-
6563
## Setup
6664

6765
### Auto Stop
@@ -76,6 +74,9 @@ http://wol-dockerized:7777/activity
7674
> This is currently not straightforward. You cannot just redirect to `/activity`. You need to use a _forward auth_ middleware.
7775
> Currently, `wol-dockerized` will respond with `200 OK`.
7876
77+
> [!TIP]
78+
> By default auto stop is enabled to disable this feature add `wol.autostop=false` to the labels.
79+
7980
### Traefik Integration
8081

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

119120
Matches an incoming request to the correct container(s) by using components extracted from the real URL.
120-
These components are made available as variables:
121+
These components are made available as **variables**:
121122

122123
- `HOSTNAME`, `HOST`, `PORT`, `PROTOCOL`, `PATH`
123124

@@ -132,12 +133,12 @@ The query pattern `{HOSTNAME}{HOSTNAME}` results in `sub.domain.comsub.domain.co
132133

133134
### `MONITOR_INTERVAL`
134135

135-
Interval in seconds for inactivity monitoring.
136+
Interval in seconds for **inactivity monitoring**.
136137

137138
### `INACTIVITY_THRESHOLD`
138139

139-
Duration (in seconds) a container can remain idle without receiving activity reports.
140-
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.
140+
Duration (in seconds) a container can remain **idle** without receiving activity reports.
141+
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**.
141142

142143
## Contributing
143144

0 commit comments

Comments
 (0)