https://github.com/gmt2001/ouroboros

Automatically update running docker containers with newest available image
https://github.com/gmt2001/ouroboros

hacktoberfest

Last synced: 10 days ago
JSON representation

Automatically update running docker containers with newest available image

• Host: GitHub
• URL: https://github.com/gmt2001/ouroboros
• Owner: gmt2001
• License: mit
• Fork: true (pyouroboros/ouroboros)
• Created: 2020-06-14T20:59:03.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T03:15:38.000Z (7 months ago)
• Last Synced: 2024-08-01T12:25:53.766Z (3 months ago)
• Topics: hacktoberfest
• Language: Python
• Homepage:
• Size: 899 KB
• Stars: 29
• Watchers: 4
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        



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](https://github.com/caronc/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](https://github.com/gmt2001/ouroboros/wiki).

### Docker

Ouroboros is deployed via docker image like so:

```bash

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](docker-compose.yml)

## Examples

Per-command and scenario examples can be found in the [wiki](https://github.com/gmt2001/ouroboros/wiki/Usage)

## Contributing

All contributions are welcome! Contributing guidelines are in the works