[feature] Customize config filename

[nathanael-h]

This is a feature request.
I'd like to be able to customize the config filename. Because this filename is used as connection name in clients (or at least on different Linux using network manager).
I saw it is harcoded here

wg-access-server/website/src/components/GetConnected.tsx

Line 35 in b71ad3f

filename: 'WireGuard.conf',

Maybe I could try a PR, with some tips.

[DasSkelett]

Just so I understand the details, does renaming the file after downloading not work, or would it just be for convenience to avoid this step?

Do you have in mind editing the filename in the web UI right before downloading (so users can choose it themselves), or setting it globally in the server config.yaml for everyone?

[nathanael-h]

Yes, I can rename the file after downloading, but for convenience I would like to avoid this.

I was thinking of defining the name in an optional setting, that would be applied server-wide.

[DasSkelett]

I see. If you want to have a go at implementing this yourself:
It needs a new config option here:
https://github.com/freifunkMUC/wg-access-server/blob/master/internal/config/config.go

Maybe also a commandline flag here:

wg-access-server/cmd/serve/main.go

Lines 38 to 63 in b71ad3f

	func Register(app *kingpin.Application) *servecmd {
	cmd := &servecmd{}
	cli := app.Command(cmd.Name(), "Run the server")
	cli.Flag("config", "Path to a wg-access-server config file").Envar("WG_CONFIG").StringVar(&cmd.ConfigFilePath)
	cli.Flag("admin-username", "Admin username (defaults to admin)").Envar("WG_ADMIN_USERNAME").Default("admin").StringVar(&cmd.AppConfig.AdminUsername)
	cli.Flag("admin-password", "Admin password (provide plaintext, stored in-memory only)").Envar("WG_ADMIN_PASSWORD").StringVar(&cmd.AppConfig.AdminPassword)
	cli.Flag("port", "The port that the web ui server will listen on").Envar("WG_PORT").Default("8000").IntVar(&cmd.AppConfig.Port)
	cli.Flag("external-host", "The external origin of the server (e.g. https://mydomain.com)").Envar("WG_EXTERNAL_HOST").StringVar(&cmd.AppConfig.ExternalHost)
	cli.Flag("storage", "The storage backend connection string").Envar("WG_STORAGE").Default("memory://").StringVar(&cmd.AppConfig.Storage)
	cli.Flag("disable-metadata", "Disable metadata collection (i.e. metrics)").Envar("WG_DISABLE_METADATA").Default("false").BoolVar(&cmd.AppConfig.DisableMetadata)
	cli.Flag("wireguard-enabled", "Enable or disable the embedded wireguard server (useful for development)").Envar("WG_WIREGUARD_ENABLED").Default("true").BoolVar(&cmd.AppConfig.WireGuard.Enabled)
	cli.Flag("wireguard-interface", "Set the wireguard interface name").Default("wg0").Envar("WG_WIREGUARD_INTERFACE").StringVar(&cmd.AppConfig.WireGuard.Interface)
	cli.Flag("wireguard-private-key", "Wireguard private key").Envar("WG_WIREGUARD_PRIVATE_KEY").StringVar(&cmd.AppConfig.WireGuard.PrivateKey)
	cli.Flag("wireguard-port", "The port that the Wireguard server will listen on").Envar("WG_WIREGUARD_PORT").Default("51820").IntVar(&cmd.AppConfig.WireGuard.Port)
	cli.Flag("vpn-allowed-ips", "A list of networks that VPN clients will be allowed to connect to via the VPN").Envar("WG_VPN_ALLOWED_IPS").Default("0.0.0.0/0", "::/0").StringsVar(&cmd.AppConfig.VPN.AllowedIPs)
	cli.Flag("vpn-cidr", "The network CIDR for the VPN").Envar("WG_VPN_CIDR").Default("10.44.0.0/24").StringVar(&cmd.AppConfig.VPN.CIDR)
	cli.Flag("vpn-cidrv6", "The IPv6 network CIDR for the VPN").Envar("WG_VPN_CIDRV6").Default("fd48:4c4:7aa9::/64").StringVar(&cmd.AppConfig.VPN.CIDRv6)
	cli.Flag("vpn-gateway-interface", "The gateway network interface (i.e. eth0)").Envar("WG_VPN_GATEWAY_INTERFACE").Default(detectDefaultInterface()).StringVar(&cmd.AppConfig.VPN.GatewayInterface)
	cli.Flag("vpn-nat44-enabled", "Enable or disable NAT of IPv6 traffic leaving through the gateway").Envar("WG_IPV4_NAT_ENABLED").Default("true").BoolVar(&cmd.AppConfig.VPN.NAT44)
	cli.Flag("vpn-nat66-enabled", "Enable or disable NAT of IPv6 traffic leaving through the gateway").Envar("WG_IPV6_NAT_ENABLED").Default("true").BoolVar(&cmd.AppConfig.VPN.NAT66)
	cli.Flag("vpn-client-isolation", "Block or allow traffic between client devices").Envar("WG_VPN_CLIENT_ISOLATION").Default("false").BoolVar(&cmd.AppConfig.VPN.ClientIsolation)
	cli.Flag("dns-enabled", "Enable or disable the embedded dns proxy server (useful for development)").Envar("WG_DNS_ENABLED").Default("true").BoolVar(&cmd.AppConfig.DNS.Enabled)
	cli.Flag("dns-upstream", "An upstream DNS server to proxy DNS traffic to. Defaults to resolvconf with Cloudflare DNS as fallback").Envar("WG_DNS_UPSTREAM").StringsVar(&cmd.AppConfig.DNS.Upstream)
	cli.Flag("dns-domain", "A domain to serve configured device names authoritatively").Envar("WG_DNS_DOMAIN").StringVar(&cmd.AppConfig.DNS.Domain)
	return cmd
	}

To communicate it to the frontend it should probably sent as part of the InfoRes response to the Info gRPC call, which contains some global, device independent data that the frontend needs:
https://github.com/freifunkMUC/wg-access-server/blob/master/proto/server.proto

...which the backend populates here:

wg-access-server/internal/services/server_service.go

Lines 59 to 70 in b71ad3f

	return &proto.InfoRes{
	Host: stringValue(&host),
	PublicKey: publicKey,
	Port: int32(s.Config.WireGuard.Port),
	// TODO IPv6 what is HostVpnIp used for, do we need HostVpnIpv6 as well?
	HostVpnIp: hostVPNIP,
	MetadataEnabled: !s.Config.DisableMetadata,
	IsAdmin: user.Claims.Contains("admin"),
	AllowedIps: allowedIPs(s.Config),
	DnsEnabled: s.Config.DNS.Enabled,
	DnsAddress: dnsAddress,
	}, nil

then you should be able to read it from AppState.Info in the fronted.

[nathanael-h]

Hello @DasSkelett would it be possible to build and release a new image with this feature?