This repository includes the "metadata" or "Extended Information" for all the official images of the Skycoin project; also host the script to make that possible.
The metadata is scraped and parsed with the help of repo-info tools
- The workspace is assumed to be any recent Linux or MacOS, no Windows instructions yet
- It is recommended to have at least 10GB of free space in the partition used used by Docker to store container data.
- A minimum of 2Mbit per second (256Kbyte/s) bandwidth is recommended. Otherwise the update process will take non-trivial time.
- It is necessary to install a git client in advance, and configure it to push commits to Github an behalf of a Github account.
The following one-time configuration is required prior to scraping image metadata.
- Log into github.com
- Configure your SSH client
- Follow the steps in Github guide to setup SSH keys
- Navigate to this repository at https://github.com/skycoin/repo-info
- Fork it under the Github account namespace of your preference. Beware of the SSH clone URL e.g.
git@github.com:simelo/skycoin-repo-info.git. - Clone your fork e.g.
git clone git@github.com:simelo/skycoin-repo-info.git
- Change working directory to repository folder to start working on it e.g.
cd skycoin-repo-info - Run the update script
./update.sh - Once the script finishes it's job is time to review the data. Just
git diffand review the new and modified files, if you spot an omission or a blank file: just repeat the last step. - If all the data is ok, then commit it & push your data to your repository fork.
- Submit a pull request against the main
skycoin/repo-inforepository.
After these steps wait for feedback from the community for your changes to be merged with upstream branch.
The update script will take care of the following tasks:
- Download repo-info tools utility
- Search and gather all the Docker images published in the Skycoin's dockerhub organization.
- "Relevant images" are the ones with at least one of the following tags
latest, develop, release, arm & dindthis list can be widened on demand tweaking it on theupdate.shscript
- "Relevant images" are the ones with at least one of the following tags
- Iterate over each repository and its tags to scrape requested metadata
- This effectively downloads the images and extracts metadata from them (
local) and also by issuing requests to Docker Hub API (remote)
- This effectively downloads the images and extracts metadata from them (
If your internet speed is low; updating might take a while and connection issues can lead to incomplete/broken information. Errors will be reported in the logs.