etix / mirrorbits

Mirrorbits is a geographical download redirector written in Go for distributing files efficiently across a set of mirrors.
MIT License
497 stars 90 forks source link

feature: Support mirror "alias" in addition to name #167

Closed joshuaboniface closed 3 months ago

joshuaboniface commented 3 months ago

Currently, the name you give a mirror in the Mirrorbits CLI is the name shown to users on the mirrorlist and mirrorstats pages.

This, however, might not be very user-friendly.

For instance, for ease of management with scripts, I name our mirrors with short "infrastructure" like names such as tor1 and sfo1. But then when a user views the mirrorlist for a given file, this is all they see under the "Mirror Name" field, i.e.

image

I'd like there to be a way to set an "Alias" or "Nice Name" (or something of that description) for each mirror, which would be what is shown to end-users on that page. This would allow us to preserve the simplicity of management (e.g. for mirror in tor1 sfo1 ...-type stuff) while providing nice names to end users (e.g. "Toronto, Canada", "San Francisco, USA East", etc.).

joshuaboniface commented 3 months ago

And I should have looked at the code first - it seems this is exactly what "Sponsor Name" does. Let this serve as a bit of documentation for what that does, or possibly a suggestion to rename it something a bit more obvious. :grin: