admin/gluetun
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(settings): refactor settings processing (#756)

Browse Source 
- Better settings tree structure logged using `qdm12/gotree`
- Read settings from environment variables, then files, then secret files
- Settings methods to default them, merge them and override them
- `DNS_PLAINTEXT_ADDRESS` default changed to `127.0.0.1` to use DoT. Warning added if set to something else.
- `HTTPPROXY_LISTENING_ADDRESS` instead of `HTTPPROXY_PORT` (with retro-compatibility)
This commit is contained in:
Quentin McGaw
2022-01-06 06:40:23 -05:00
committed by GitHub
parent 46738b2934
commit 7d824a5179
275 changed files with 7167 additions and 6328 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
internal/vpn/loop.go
View File

@@ -4,7 +4,7 @@ import (
"net/http"
"time"
"github.com/qdm12/gluetun/internal/configuration"
"github.com/qdm12/gluetun/internal/configuration/settings"
"github.com/qdm12/gluetun/internal/constants"
"github.com/qdm12/gluetun/internal/dns"
"github.com/qdm12/gluetun/internal/firewall"
@@ -68,7 +68,7 @@ const (
defaultBackoffTime = 15 * time.Second
)
func NewLoop(vpnSettings configuration.VPN, vpnInputPorts []uint16,
func NewLoop(vpnSettings settings.VPN, vpnInputPorts []uint16,
allServers models.AllServers, openvpnConf openvpn.Interface,
netLinker netlink.NetLinker, fw firewallConfigurer, routing routing.VPNGetter,
portForward portforward.StartStopper, starter command.Starter,

4
internal/vpn/openvpn.go
View File

@@ -5,7 +5,7 @@ import (
"errors"
"fmt"
"github.com/qdm12/gluetun/internal/configuration"
"github.com/qdm12/gluetun/internal/configuration/settings"
"github.com/qdm12/gluetun/internal/firewall"
"github.com/qdm12/gluetun/internal/openvpn"
"github.com/qdm12/gluetun/internal/provider"
@@ -24,7 +24,7 @@ var (
// It returns a serverName for port forwarding (PIA) and an error if it fails.
func setupOpenVPN(ctx context.Context, fw firewall.VPNConnectionSetter,
openvpnConf openvpn.Interface, providerConf provider.Provider,
settings configuration.VPN, starter command.Starter, logger openvpn.Logger) (
settings settings.VPN, starter command.Starter, logger openvpn.Logger) (
runner vpnRunner, serverName string, err error) {
connection, err := providerConf.GetConnection(settings.Provider.ServerSelection)
if err != nil {

4
internal/vpn/run.go
View File

@@ -29,9 +29,9 @@ func (l *Loop) Run(ctx context.Context, done chan<- struct{}) {
for ctx.Err() == nil {
settings, allServers := l.state.GetSettingsAndServers()
providerConf := provider.New(settings.Provider.Name, allServers, time.Now)
providerConf := provider.New(*settings.Provider.Name, allServers, time.Now)
portForwarding := settings.Provider.PortForwarding.Enabled
portForwarding := *settings.Provider.PortForwarding.Enabled
var vpnRunner vpnRunner
var serverName, vpnInterface string
var err error

6
internal/vpn/settings.go
View File

@@ -3,18 +3,18 @@ package vpn
import (
"context"
"github.com/qdm12/gluetun/internal/configuration"
"github.com/qdm12/gluetun/internal/configuration/settings"
"github.com/qdm12/gluetun/internal/vpn/state"
)
type SettingsGetSetter = state.SettingsGetSetter
func (l *Loop) GetSettings() (settings configuration.VPN) {
func (l *Loop) GetSettings() (settings settings.VPN) {
return l.state.GetSettings()
}
func (l *Loop) SetSettings(ctx context.Context,
vpn configuration.VPN) (
vpn settings.VPN) (
outcome string) {
return l.state.SetSettings(ctx, vpn)
}

10
internal/vpn/state/state.go
View File

@@ -3,7 +3,7 @@ package state
import (
"sync"
"github.com/qdm12/gluetun/internal/configuration"
"github.com/qdm12/gluetun/internal/configuration/settings"
"github.com/qdm12/gluetun/internal/loopstate"
"github.com/qdm12/gluetun/internal/models"
)
@@ -13,11 +13,11 @@ var _ Manager = (*State)(nil)
type Manager interface {
SettingsGetSetter
ServersGetterSetter
GetSettingsAndServers() (vpn configuration.VPN, allServers models.AllServers)
GetSettingsAndServers() (vpn settings.VPN, allServers models.AllServers)
}
func New(statusApplier loopstate.Applier,
vpn configuration.VPN, allServers models.AllServers) *State {
vpn settings.VPN, allServers models.AllServers) *State {
return &State{
statusApplier: statusApplier,
vpn: vpn,
@@ -28,14 +28,14 @@ func New(statusApplier loopstate.Applier,
type State struct {
statusApplier loopstate.Applier
vpn configuration.VPN
vpn settings.VPN
settingsMu sync.RWMutex
allServers models.AllServers
allServersMu sync.RWMutex
}
func (s *State) GetSettingsAndServers() (vpn configuration.VPN,
func (s *State) GetSettingsAndServers() (vpn settings.VPN,
allServers models.AllServers) {
s.settingsMu.RLock()
s.allServersMu.RLock()

10
internal/vpn/state/vpn.go
View File

@@ -4,23 +4,23 @@ import (
"context"
"reflect"
"github.com/qdm12/gluetun/internal/configuration"
"github.com/qdm12/gluetun/internal/configuration/settings"
"github.com/qdm12/gluetun/internal/constants"
)
type SettingsGetSetter interface {
GetSettings() (vpn configuration.VPN)
SetSettings(ctx context.Context, vpn configuration.VPN) (outcome string)
GetSettings() (vpn settings.VPN)
SetSettings(ctx context.Context, vpn settings.VPN) (outcome string)
}
func (s *State) GetSettings() (vpn configuration.VPN) {
func (s *State) GetSettings() (vpn settings.VPN) {
s.settingsMu.RLock()
vpn = s.vpn
s.settingsMu.RUnlock()
return vpn
}
func (s *State) SetSettings(ctx context.Context, vpn configuration.VPN) (
func (s *State) SetSettings(ctx context.Context, vpn settings.VPN) (
outcome string) {
s.settingsMu.Lock()
settingsUnchanged := reflect.DeepEqual(s.vpn, vpn)

2
internal/vpn/tunnelup.go
View File

@@ -26,7 +26,7 @@ func (l *Loop) onTunnelUp(ctx context.Context, data tunnelUpData) {
}
}
if l.dnsLooper.GetSettings().Enabled {
if *l.dnsLooper.GetSettings().DoT.Enabled {
_, _ = l.dnsLooper.ApplyStatus(ctx, constants.Running)
}

4
internal/vpn/wireguard.go
View File

@@ -5,7 +5,7 @@ import (
"errors"
"fmt"
"github.com/qdm12/gluetun/internal/configuration"
"github.com/qdm12/gluetun/internal/configuration/settings"
"github.com/qdm12/gluetun/internal/firewall"
"github.com/qdm12/gluetun/internal/netlink"
"github.com/qdm12/gluetun/internal/provider"
@@ -22,7 +22,7 @@ var (
// It returns a serverName for port forwarding (PIA) and an error if it fails.
func setupWireguard(ctx context.Context, netlinker netlink.NetLinker,
fw firewall.VPNConnectionSetter, providerConf provider.Provider,
settings configuration.VPN, logger wireguard.Logger) (
settings settings.VPN, logger wireguard.Logger) (
wireguarder wireguard.Wireguarder, serverName string, err error) {
connection, err := providerConf.GetConnection(settings.Provider.ServerSelection)
if err != nil {