You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

59 lines
1.9 KiB
Markdown

# DEPRECATED
Due to #13 and various other breaking changes, we decided to not spend more time on this custom homemade script and head to more standard and usable solutions such as [diun](https://crazymax.dev/diun/) to get update notifications, which seems more fitting to our technical needs.
After 3 years of use in production, this script is now deprecated and will not be further maintained.
The script is licensed under the MPL 2.0 license. Feel free to reuse for any project as long as you respect this license.
---
# docker-update-images
Script to update Docker images easily.
- Checks image updates with DockerHub's API (without pulling)
- Pulls new versions automatically from DockerHub
- Rebuilds child images (and their children, and so on)
- Automatically deletes old images
- Automatically restarts updated services
- All information concerning images are written in `services.json`
- 250 lines of Python (including ~20% of comments), easy to read
Alpha stage, but used in production on [42l](https://42l.fr)'s servers.
Might receive some updates from time to time (see Issues).
### Screenshot
![Screenshot](.git-assets/screenshot.png)
### How to use
**Find a guide here**: https://git.42l.fr/42l/docker-update-images/wiki/How-to-use
#### Quick start
Want to test it right away without reading the documentation? Alright, here you go:
- `git clone https://git.42l.fr/42l/docker-update-images`
- `cd docker-update-images`
- `mv services-example.json services.json`
- `./update-images.py`
More information on the above guide.
### Script diagram
Here's a [drawio](https://draw.42l.fr) diagram representing the script's algorithm. It's not very up-to-date, but it should be enough for you to have an idea of how the script operates.
![Algorithm](.git-assets/diagram.png)
You can find and edit the diagram in the `.git-assets` folder.
Enjoy!
### License
This script is licensed under the [Mozilla Public License 2.0](.git-assets/LICENSE).