Your next MirrorS is not MirrorS, nor MirrorSes, it's MirrorZ.
A final site for Mirror sites.
https://mirrorz.org. Currently mirrorz.json for each Mirror site is real-time or statically generated by MirrorZ, by their maintainers or by a third party.
Also legacy webpages (for w3m and noscript users) are provided in https://mirrorz.org/_/
A speed test script oh-my-mirrorz.py is also provided. See README to more info.
Mirror sites are heterogeneous. It is hard for a single mirror to provide all mirrors, so differences occur.
For end users, this is not a good experience as they need to search for available mirrors.
To make things easy, MirrorZ is intended to include all mirrorS, so a unified interface is needed.
A mirrorz.json in the following format describes all the data of one mirror site in MirrorZ.
{
"version": 1.5,
"site": {
"url": "https://example.org",
"logo": "https://example.org/img/logo.svg",
"logo_darkmode": "https://example.org/img/logo-white.svg",
"abbr": "EXAMPLE",
"name": "样例镜像站",
"homepage": "https://blog.example.org",
"issue": "https://github.com/example/issues",
"request": "https://github.com/example/mirror-request",
"email": "[email protected]",
"group": "QQ: 10086 and/or Telegram @something",
"disk": "may be any string showing usage of disk, e.g. usage",
"note": "may be any string; like speed limit or connection limit",
"big": "/speedtest/1000mb.bin"
},
"info": [
{
"distro": "Debian",
"category": "os",
"urls": [
{
"name": "10.7.0 (amd64, CD installer with xfce)",
"url": "/debian-cd/current/amd64/iso-cd/debian-10.7.0-amd64-xfce-CD-1.iso"
}
]
}
],
"mirrors": [
{
"cname": "AOSP",
"desc": "Android 操作系统源代码",
"url": "/AOSP",
"status": "S",
"help": "/help/AOSP/",
"upstream": "https://android.googlesource.com/mirror/manifest",
"size": "596G"
},
{
"cname": "AUR",
"desc": "Arch Linux 用户软件库",
"url": "https://aur.tuna.tsinghua.edu.cn",
"status": "S1612195849X1612196849N",
"help": "/help/AUR/",
"upstream": "https://aur.archlinux.org/"
}
]
}versionis optional for version 1.x- previous versions of this protocol could be found in git history; protocols in v1.x are back-ward compatible
siteprovides the global info about one mirror site- only
site.urlandsite.abbrare mandatory site.logoshould not be of formatico. Also, at least 64x64 resolution is requiredsite.logo_darkmodeis used when browser uses dark mode. Note that it should be set only aftersite.logois setsite.urlshould not end with slash/site.bigshould be a valid url to a big file, used byoh-my-mirrorz.pyfor speed testing
- only
infois used for category view- all field of
infois mandatory infomay be left empty as[]- the name of
info.distroshould be agreed and have a mapping, maintained incname.json
- all field of
mirrorsis used for list view- the name of
mirrors.cnameshould be agreed and have a mapping, maintained incname.json mirrors.descmay differ for each mirror site since there areexcludesfor some mirror sitemirrors.descmay be empty- if
mirrors.urlbegins with a slash/, it should be appended tosite.urlto form a full url mirrors.statusis a concat of strings of pattern[A-Z](\d+)?. Only one main status is allowed; the number of auxiliary status is not limited.S1600000000: successful. (optional) last successful ended unix timestampY1600000000: syncing. (optional) start to sync unix timestampF1600000000: failed. (optional) last attempt to sync unix timestampP1600000000: paused. (optional) the unix timestamp sync stoppedC: cacheR: reverse proxyU: unknownX1600000000: (auxiliary) next scheduled sync unix timestampN1600000000: (auxiliary) new mirror. (optional) unix timestamp the repo addedO1600000000: (auxiliary) old successful timestamp, used only when it is syncing or failed
mirrors.helpmay be empty, or the same rule asmirrors.urlmirrors.upstream,mirrors.sizemay be empty
- the name of
MirrorZ only provides the data format (including cname.json), frontend and related scripts (e.g oh-my-mirrorz.py). Audit on data format, content (e.g. cname.json) and adopted technologies (e.g. using reverse proxy in parsers) can be done by MirrorZ. Monitor and Backend are experimental features of MirrorZ, and MirrorZ provides no warranty on these services.
The term 'Mirror site' refers to an actual mirror site and/or the corresponding organization.
The term 'Third party' refers to individuals/organizations that contribute to this project. This may overlap with 'Mirror site'.
Data like mirrorz.json or site.json and parsers in src/parser are contributed/maintained by some Third party, and can be placed in this repo for convenience. More specifically, to make parser/data usable by MirrorZ (e.g. data format, CORS policy) is the responsibility of one Third party; also it is optional for one Third party to support some feature like legacy page and oh-my-mirrorz.
For one Third party, it should either add and maintain their url to a mirrorz json file in src/config/upstream.js and src/config/mirrors.js (legacy page and script support), in the url https is needed; Or, integrate their frontend parser in src/parser and src/Root.jsx, where the generated mirrorz.json is called dynamic mirrorz.json, and may generate a static mirrorz.json by debug interface in /static/json/legacy/ and add the corresponding url in src/config/mirrors.js for legacy page and script support.
For Third party providing an url to a mirrorz json file, it may also contribute their mirrorz.json generating scripts in the directory scripts.
Big changes by Third party should be made through PR like adding a new parser/generating script. Small changes like changing content in site.json or generating scripts can be done by pushing to the master.
One may use
yarn --frozen-lockfile
yarn start
to start a local server. It is often convenient for debugging frontend features like html/css since auto-reload is provided by parcel.
To debug one src/parser with new json to be hosted in MirrorZ, one may change https://mirrorz.org/static/json/legacy to http://localhost:1234/static/json/legacy for example, and use
yarn --frozen-lockfile
yarn half_start
to start a local server. Python3 is required in this case. Note there is no auto-reload feature.
To use static files, 404 redirection (emulate Github pages) and legacy pages, one may use
yarn --frozen-lockfile
yarn full_start
to start a local server. Python3 is required in this case. Note there is no auto-reload feature.
For dynamic web page part, only
yarn build
is required.
However if one also wants to deploy the static web page, one may use
yarn build
yarn legacy_build
Note that legacy_build has dependencies on files yarn build has made.
Meanwhile, to generate the complete oh-my-mirrorz.py, one should use the following commands
sed -i "s/^VERSION.*/VERSION = '$(date +'%Y%m%d')'/g" scripts/oh-my-mirrorz/oh-my-mirrorz.py
sed -i "s^mirrors = \[\]^mirrors = $(node -e 'console.log(JSON.stringify(require("./src/config/mirrors")))')^" scripts/oh-my-mirrorz/oh-my-mirrorz.py
Currently *.json is ignored in .gitignore (not ignored in /static). If one wants to commit a json file, they should use git add -f.