Skip to content

Commit 056a076

Browse files
Update README.md
1 parent c26f265 commit 056a076

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# WoL Dockerized
2+
3+
WoL Dockerized is a Docker Container that allows you to start requested Docker Containers.
4+
It also stops Containers after a threshold of Inactivity.
5+
6+
## Installation
7+
8+
Get the latest `docker-compose.yaml` file:
9+
10+
```yaml
11+
---
12+
services:
13+
wol-dockerized:
14+
image: ghcr.io/codeshelldev/wol-dockerized:latest
15+
container_name: wol-dockerized
16+
environment:
17+
- PATTERN={HOSTNAME}
18+
- MONITOR_INTERVAL=60
19+
- INACTIVITY_THRESHOLD=600
20+
```
21+
22+
```bash
23+
docker compose up -d
24+
```
25+
26+
## Usage
27+
28+
Start Container with `query`: `jellyfin.mydomain.com`:
29+
30+
```bash
31+
curl -X POST -H "Content-Type: application/json" -d '{"query": "jellyfin.mydomain.com"}' http://wol-dockerized.mydomain.com
32+
```
33+
34+
```yaml
35+
---
36+
services:
37+
jellyfin:
38+
image: jelylfin/jellyfin:latest
39+
labels:
40+
- wol.enable=true
41+
- wol.query=jellyfin.mydomain.com
42+
- wol.autostop=true
43+
```
44+
45+
## Contributing
46+
47+
## License
48+
49+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)