Skip to content

Commit c58f091

Browse files
committed
2 parents 3bc47ad + 4938c4b commit c58f091

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ services:
1313
wol-dockerized:
1414
image: ghcr.io/codeshelldev/wol-dockerized:latest
1515
container_name: wol-dockerized
16+
ports:
17+
- "7777:7777"
1618
environment:
1719
- PATTERN={HOSTNAME}
1820
- MONITOR_INTERVAL=60
@@ -25,12 +27,30 @@ docker compose up -d
2527

2628
Combine with [WoL-Redirect](https://github.com/codeshelldev/wol-redirect) for a graphical interface.
2729

30+
## Setup
31+
32+
### Auto-stop
33+
34+
If you want your Docker Containers to automatically stop after a certain Inactivity Threshold you will have to somehow redirect requests to said service
35+
through `http://localhost:7777/endpoint`.
36+
37+
! Info
38+
39+
> This is currently not that simple
40+
> you cannot just redirect to `/endpoint`,
41+
> you will have to use a _forward auth_ middleware
42+
> this means `wol-dockerized` currently just responds with 200 OK
43+
44+
#### Traefik
45+
46+
Look at [forward auth](https://doc.traefik.io/traefik/middlewares/http/forwardauth/)
47+
2848
## Usage
2949

3050
Start Container with `query`: `jellyfin.mydomain.com`:
3151

3252
```bash
33-
curl -X POST -H "Content-Type: application/json" -d '{"query": "jellyfin.mydomain.com"}' http://wol-dockerized.mydomain.com
53+
curl -X POST -H "Content-Type: application/json" -d '{"query": "jellyfin.mydomain.com"}' http://localhost:7777
3454
```
3555

3656
```yaml
@@ -46,6 +66,19 @@ services:
4666
4767
## Contributing
4868
69+
Found a bug or have new ideas or enhancements for this Project?
70+
Feel free to open up an issue or create a Pull Request!
71+
72+
## TODO
73+
74+
! Info
75+
76+
> This should be really easy:
77+
> instead of returning 200 OK on `/endpoint` just redirect back to original url,
78+
> but wait...
79+
> When going to the original url you will just be redirected back to `/endpoint`!
80+
> But this would further complicate the whole **WoL-Stack** setup...
81+
4982
## License
5083

5184
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)