diff --git a/README.md b/README.md index 11765c9..961d6ab 100644 --- a/README.md +++ b/README.md @@ -6,29 +6,29 @@ Putting your containers to sleep --- ## How it works -### Lazy loading containers -monitor network traffic for active connections and recieved packets , -if traffic looks to be idle, your container stops -if it looks like you're trying to access a stopped container, it 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? +## Want to test it? ``` $ git clone https://github.com/vmorganp/Lazytainer $ cd Lazytainer $ docker-compose up ``` -### Or put in your docker compose +## Or put in your docker compose ``` lazytainer: container_name: lazytainer image: ghcr.io/vmorganp/lazytainer:master environment: - - PORT=81,82 # comma separated list of ports...or just the one - - LABEL=lazytainer # value of lazytainer.marker for other containers that lazytainer checks - # - TIMEOUT=30 # OPTIONAL number of seconds to let container idle - # - RXHISTLENGTH=10 # OPTIONAL number of seconds to keep rx history, uptime is calculated as first item and last item from this and must have a gap of at least $MINPACKETTHRESH - # - MINPACKETTHRESH=10 # OPTIONAL number of packets that must be recieved to keepalive/start container + - PORT=81 # comma separated list of ports...or just the one + - LABEL=lazytainer # value of lazytainer.marker for other containers that lazytainer checks + # - TIMEOUT=30 # OPTIONAL number of seconds to let container idle + # - MINPACKETTHRESH=10 # OPTIONAL number of packets that must be recieved to keepalive/start container + # - POLLRATE=1 # OPTIONAL number of packets that must be recieved to keepalive/start container + # - VERBOSE=true # probably set this to false unless you're debugging or doing the initial demo ports: - 81:81 volumes: @@ -43,7 +43,4 @@ $ docker-compose up - lazytainer # wait for lazytainer to start before starting labels: - "lazytainer.marker=lazytainer" # required label to make it work -``` - -## TODO -- improve logging - verbosity flags \ No newline at end of file +``` \ No newline at end of file diff --git a/docker-compose.yaml b/docker-compose.yaml index 609039d..c62c8a1 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -6,10 +6,10 @@ services: environment: - PORT=81,82 # comma separated list of ports...or just the one - LABEL=lazytainer # value of lazytainer.marker for other containers that lazytainer checks - # - TIMEOUT=30 # OPTIONAL number of seconds to let container idle - # - MINPACKETTHRESH=10 # OPTIONAL number of packets that must be recieved to keepalive/start container - # - POLLRATE=5 # OPTIONAL number of packets that must be recieved to keepalive/start container - # - VERBOSE=true + - TIMEOUT=30 # OPTIONAL number of seconds to let container idle + - MINPACKETTHRESH=10 # OPTIONAL number of packets that must be recieved to keepalive/start container + - POLLRATE=1 # OPTIONAL number of packets that must be recieved to keepalive/start container + - VERBOSE=true # probably set this to false unless you're debugging or doing the initial demo ports: - 81:81 - 82:82