mirrors/Lazytainer
1
0
Fork 0
mirror of https://github.com/vmorganp/Lazytainer.git synced 2025-12-24 14:31:44 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs to address some common questions, include build status

Browse Source
This commit is contained in:
Morgan Patterson
2022-08-28 13:31:42 -07:00
committed by GitHub
parent 5befafe343
commit 61a3c2bc17
1 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -1,14 +1,12 @@
# Lazytainer - Lazy Load Containers
Putting your containers to sleep
*I don't really wanna do the work today*
[![Docker](https://github.com/vmorganp/Lazytainer/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/vmorganp/Lazytainer/actions/workflows/docker-publish.yml)
---
## How it works
monitors network traffic for active connections and recieved packets
if traffic looks to be idle, container stops
if traffic is incoming to stopped container, container starts
Monitors network traffic for active connections and recieved packets
If traffic looks to be idle, container stops
If traffic is incoming to stopped container, container starts
## Want to test it?
```
@@ -17,7 +15,7 @@ $ cd Lazytainer
$ docker-compose up
```
## Or put in your docker compose
## Or put in your docker-compose.yaml
```
lazytainer:
container_name: lazytainer
@@ -43,4 +41,18 @@ $ docker-compose up
- lazytainer # wait for lazytainer to start before starting
labels:
- "lazytainer.marker=lazytainer" # required label to make it work
```
```
## Configuration
### Notes
- Lazytainer does not "automatically" start and stop all of your containers. You must apply a label to them and proxy their traffic through the Lazytainer container.
### Environment Variables
| Variable | Purpose |
| --------------- | ---------------------------------------------------------------------------------------------------------- |
| PORT | Port number(s) to listen for traffic on. If specifying multiple, they should be comma separated |
| LABEL | Value for label `lazytainer.marker` that lazytainer should use to determine which containers to start/stop |
| TIMEOUT | Number of seconds container will be allowed to run with no traffic before it is stopped |
| MINPACKETTHRESH | Mimimum amount of recieved network packets to keep container alive |
| POLLRATE | Number of seconds to wait between polls of network transmission stats |
| VERBOSE | Whether or not to print noisier logs that may be useful for debugging |