Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.87 KB

README.md

File metadata and controls

46 lines (28 loc) · 1.87 KB
Raw

Ouroboros Logo

Automatically update your running Docker containers to the latest available image.

The de-facto standard for docker update automation

Forked from the original at https://github.com/pyouroboros/ouroboros/

Overview

Ouroboros will monitor (all or specified) running docker containers and update them to the (latest or tagged) available image in the remote registry. The updated container uses the same tag and parameters that were used when the container was first created such as volume/bind mounts, docker network connections, environment variables, restart policies, entrypoints, commands, etc.

  • Push your image to your registry and simply wait your defined interval for ouroboros to find the new image and redeploy your container autonomously.
  • Notify you via many platforms courtesy of Apprise
  • Serve metrics for trend monitoring (Currently: Prometheus/Influxdb)
  • Limit your server ssh access
  • ssh -i key server.domainname "docker pull ... && docker run ..." is for scrubs
  • docker-compose pull && docker-compose up -d is for fancier scrubs

Getting Started

More detailed usage and configuration can be found on the wiki.

Docker

Ouroboros is deployed via docker image like so:

docker run -d --name ouroboros \
  -v /var/run/docker.sock:/var/run/docker.sock \
  ghcr.io/gmt2001/ouroboros

This image is compatible with amd64, arm64, and arm/v7 CPU architectures

or via docker-compose:

Official Example

Examples

Per-command and scenario examples can be found in the wiki

Contributing

All contributions are welcome! Contributing guidelines are in the works