refactor(storage): new storage file structure

- new directory structure containing manifest.json and one json file per provider, by default.
- the manifest.json file can specify a filepath for each vpn provider
- each vpn provider json data file can contain the `"preferred": true` field to enforce it is used even if outdated, unless there is a version mismatch
- `STORAGE_SERVERS_DIRECTORY_PATH` replaces `STORAGE_FILEPATH` (which is now a migration source only). It sets the directory where server manifest and per-provider JSON files are stored (default: `/gluetun/servers/`).
- First-run migration: On startup, gluetun checks for the old /gluetun/servers.json file; if found and no new manifest exists, it automatically migrates all data to /gluetun/servers/ directory structure
- Silent fallback: If legacy file isn't found, uses the new directory path normally
- Legacy cleanup: After successful migration, attempts to remove the old fat JSON file (logs warning only if removal fails, e.g., read-only bind mounts)
This commit is contained in:
Quentin McGaw
2026-04-27 02:47:30 +00:00
parent 13503b0ae0
commit d9cc7dcffb
303 changed files with 304957 additions and 304344 deletions
@@ -0,0 +1,65 @@
package windscribe
import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/netip"
"strconv"
"time"
)
type apiData struct {
Data []regionData `json:"data"`
}
type regionData struct {
Region string `json:"name"`
Groups []groupData `json:"groups"`
}
type groupData struct {
City string `json:"city"`
Nodes []serverData `json:"nodes"`
OvpnX509 string `json:"ovpn_x509"`
WgPubKey string `json:"wg_pubkey"`
}
type serverData struct {
Hostname string `json:"hostname"`
IP netip.Addr `json:"ip"`
IP2 netip.Addr `json:"ip2"`
IP3 netip.Addr `json:"ip3"`
}
func fetchAPI(ctx context.Context, client *http.Client) (
data apiData, err error,
) {
const baseURL = "https://assets.windscribe.com/serverlist/mob-v2/1/"
cacheBreaker := time.Now().Unix()
url := baseURL + strconv.Itoa(int(cacheBreaker))
request, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
if err != nil {
return data, err
}
response, err := client.Do(request)
if err != nil {
return data, err
}
defer response.Body.Close()
if response.StatusCode != http.StatusOK {
return data, fmt.Errorf("HTTP status code not OK: %d %s",
response.StatusCode, response.Status)
}
decoder := json.NewDecoder(response.Body)
if err := decoder.Decode(&data); err != nil {
return data, fmt.Errorf("decoding response body: %w", err)
}
return data, nil
}
@@ -0,0 +1,73 @@
package windscribe
import (
"context"
"fmt"
"net/netip"
"sort"
"github.com/qdm12/gluetun-servers/pkg/constants"
"github.com/qdm12/gluetun-servers/pkg/models"
"github.com/qdm12/gluetun-servers/pkg/updaters/common"
)
func (u *Updater) FetchServers(ctx context.Context, minServers int) (
servers []models.Server, err error,
) {
data, err := fetchAPI(ctx, u.client)
if err != nil {
return nil, err
}
for _, regionData := range data.Data {
region := regionData.Region
for _, group := range regionData.Groups {
city := group.City
x5090Name := group.OvpnX509
wgPubKey := group.WgPubKey
for _, node := range group.Nodes {
ips := make([]netip.Addr, 0, 2) //nolint:mnd
if node.IP.IsValid() {
ips = append(ips, node.IP)
}
if node.IP2.IsValid() {
ips = append(ips, node.IP2)
}
server := models.Server{
VPN: constants.OpenVPN,
TCP: true,
UDP: true,
Region: region,
City: city,
Hostname: node.Hostname,
OvpnX509: x5090Name,
IPs: ips,
}
servers = append(servers, server)
if !node.IP3.IsValid() { // Wireguard + Stealth
continue
} else if wgPubKey == "" {
return nil, fmt.Errorf("no wireguard public key found: for node %s", node.Hostname)
}
server.VPN = constants.Wireguard
server.UDP = false
server.TCP = false
server.OvpnX509 = ""
server.WgPubKey = wgPubKey
server.IPs = []netip.Addr{node.IP3}
servers = append(servers, server)
}
}
}
if len(servers) < minServers {
return nil, fmt.Errorf("%w: %d and expected at least %d",
common.ErrNotEnoughServers, len(servers), minServers)
}
sort.Sort(models.SortableServers(servers))
return servers, nil
}
@@ -0,0 +1,27 @@
package windscribe
import (
"net/http"
"github.com/qdm12/gluetun-servers/pkg/updaters/common"
)
type Updater struct {
client *http.Client
warner common.Warner
}
func New(client *http.Client, warner common.Warner) *Updater {
return &Updater{
client: client,
warner: warner,
}
}
func (u *Updater) Version() uint16 {
return 2 //nolint:mnd
}
func (u *Updater) Name() string {
return "windscribe"
}