From b8b9a596aef96cfcf06ad38e59262cea5c1944f2 Mon Sep 17 00:00:00 2001 From: Carlo Landmeter Date: Tue, 5 Dec 2017 11:09:27 +0100 Subject: update readme.md --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 682dcf2..a08b095 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ # alpine-mirror-status -Scripts to generate Alpine mirror statistics + +Scripts to generate Alpine mirror statistics. + +## Dependencies + +```bash +apk add lua5.3-cjson lua5.3-http lua5.3-lustache lua5.3-lyaml +``` + +## Usage + +### List of APKINDEX.tar.gz files + +The base for checking all APKINDEX files is the provided apkindex.list file. This file is generated from the master mirror ie: + +```bash +cd /var/www/localhost/htdocs +find alpine -name APKINDEX.tar.gz > apkindex.list +``` + +### Create a config file + +Copy the sample config to a new file called config.lua and change the defaults if needed (ie the output directory). + +### Generate json file + +```bash +./generate-json.lua +``` + +Which will iterate over earch mirror/apkindex combination and make an http request to fetch the last-modified header. + +### Generate html file + +```bash +./genereate-html.lua +``` + +Which will generate two parts: + +1. Generate a list of mirrors take from official mirrors.yaml file. +2. Compare all mirrors with master and generate a health report table per mirror. -- cgit v1.2.3