cybersecsi/raudiA repo to automatically generate and keep updated a series of Docker images through GitHub Actions.
RAUDI (Regularly and Automatically Updated Docker Images) automatically generates and keep updated a series of Docker Images through GitHub Actions for tools that are not provided by the developers.
RAUDI is what will save you from creating and managing a lot of Docker Images manually. Every time a software is updated you need to update the Docker Image if you want to use the latest features, the dependencies are not working anymore.
This is messy and time-consuming.
Don't worry anymore, we got you covered.
You may either fork this repo and use the GitHub Workflow yourself or use it locally (and manage its execution the way you want).
If you want to fork this repo you also have to set up some secrets to be able to push your images on your personal Docker Hub account. Two GitHub secrets must be set:
After setting those secrets you have to edit the organization variable set in the tools/main.py file since it is configured to push on the Docker Hub for SecSI.
That's all guys: go to Action, enable it for your forked repo, wait until midnight, and the Workflow will do the heavy work!
This repo can also be executed locally. The requirements to be met are the following:
Here is the documentation for working with BuildX: https://docs.docker.com/buildx/working-with-buildx/
The setup phase is pretty straightforward, you just need the following commands:
git clone https://github.com/cybersecsi/RAUDI
cd RAUDI
pip install -r requirements.txt
You're ready to go!
To run the test you need to install pytest with the command pip install pytest (it is not in requirements.txt since it is needed only for testing purposes) and then you may run:
pytest -s
or
python -m pytest -s
to run the tests.
RAUDI can build and push all the tools that are put into the tools directory. There are different options that can be used when running it. Before using it locally you should create a .env file (you can just copy the .env.sample file) and add your GitHub Personal Access Token to avoid Rate Limiting. For unauthenticated users GitHub allows up to 60 requests per hour, while authenticated users are allowed up to 15.000 requests per hour. For this reason we advice you to add it! You can also create a personal access token without any scope since anything we do is read some info for every GitHub repo.
In this mode RAUDI tries to build all the tools if needed. The command to run it is simply:
python3 ./raudi.py --all
In this mode RAUDI tries to build only the specified tool. The command in this case is:
python3 ./raudi.py --single <tool_name>
tool_name MUST be the name of the directory inside the tools folder.
Since the tests parameter has been added to the configuration structure of the tool is can be helpful to test if the inserted commands do return a 0 status code. The command to test a specific tool is:
python3 ./raudi.py --test <tool_name>
tool_name MUST be the name of the directory inside the tools folder.
If you want to know the available tools you can run this command:
python3 ./raudi.py --list
If you want to quickly add a new tool folder starting from one of the available templates you can run this command:
python3 ./raudi.py --bootstrap <new_tool_name>
| Option | Description | Default Value |
|---|---|---|
| --push | Whether automatically push to Docker Hub | False |
| --remote | Whether check against Docker Hub instead of local Docker before build | False |
| --force | Whether build or not if an image with the same tagname has been found | False |
This is the current list of tools that have been added. Those are all tools that do not have an official Docker Image provided by the developer: