`inbuxa join https://mail.example.com --key KEY` installs the front ends on this machine for a mail server already running on another one. That server is reached only over its own HTTPS, with an API key a server administrator made in the console (--key -, or INBUXA_JOIN_KEY, keeps it out of the shell's history; it is never written down). Through it the front ends' addresses and a webmail client secret made here go into the server's inbuxa:FrontEnds (server #195), which registers their sign-in and allows the console's origin on every node, with no restart and nothing done by hand on that machine. It asks first, dry runs included, and refuses with the reason when the key is wrong, the server has no inbuxa:FrontEnds, it already lists other front ends (--replace), or its environment owns the webmail's secret. Then it installs the console and the webmail in containers with Caddy, registers them, exempts the webmail's address from the server's auto-ban (what its name resolves to, loopback for a loopback server, or --exempt-address), and checks that the server lets the console call it. A second join with the same addresses converges. The compose file learns a server elsewhere: the webmail reaches it at its address, and Caddy serves only the front ends' names. Container and host-server installs render as before. INBUXA_SERVER_BINARY installs a server build instead of the release wherever the server goes on the host, for testing a server change before it is released; e2e/vm/run.sh passes one in with SERVER_BINARY=. e2e/cases/join.sh: 24 checks on Debian 13 against a build of server #195, ending with a person signing in to the joined webmail. install-local, install-host, install-public, status-export and topology pass unchanged.
301 lines
9.1 KiB
Go
301 lines
9.1 KiB
Go
// SPDX-FileCopyrightText: 2026 Coffey Labs LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
// Package compose writes the deployment: a compose file, a Caddyfile, and the
|
|
// .env beside them that holds the secrets those two refer to.
|
|
//
|
|
// The files are the deployment. Once they are written, `docker compose up -d`
|
|
// in that directory is the whole of it, with or without this installer -- an
|
|
// operator who never runs `inbuxa` again still has something they can read,
|
|
// edit and bring up by hand.
|
|
package compose
|
|
|
|
import (
|
|
"crypto/rand"
|
|
"embed"
|
|
"encoding/base64"
|
|
"fmt"
|
|
"net"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"text/template"
|
|
)
|
|
|
|
//go:embed templates/*.tmpl
|
|
var templates embed.FS
|
|
|
|
// Stack is everything the two templates need. It is flat on purpose: a
|
|
// template that reaches through three structs to find a hostname is a
|
|
// template nobody can check against the file it produces.
|
|
type Stack struct {
|
|
Version string
|
|
Project string
|
|
Domain string
|
|
Email string
|
|
Local bool
|
|
|
|
MailHost string
|
|
ConsoleHost string
|
|
WebmailHost string
|
|
|
|
Server bool // the server runs in this compose project
|
|
Console bool
|
|
Webmail bool
|
|
Proxy bool
|
|
|
|
// HostServer is a mail server running on this machine but outside the
|
|
// project, under systemd. The front ends and the proxy then reach it on
|
|
// loopback, so the ones that talk to it -- the webmail and Caddy -- share
|
|
// the host's network instead of the project's. The console does not:
|
|
// only the browser talks to the server from it.
|
|
HostServer bool
|
|
|
|
// RemoteServerURL is a mail server on another machine, which the front
|
|
// ends here were joined to (`inbuxa join`). Nothing here serves its
|
|
// names; the webmail reaches it at this address.
|
|
RemoteServerURL string
|
|
|
|
ServerImage string
|
|
ConsoleImage string
|
|
WebmailImage string
|
|
CaddyImage string
|
|
|
|
ServerBind string // host address for the server's plain HTTP
|
|
ConsoleBind string
|
|
WebmailBind string
|
|
|
|
Subnet string
|
|
ServerIP string
|
|
ConsoleIP string
|
|
WebmailIP string
|
|
CaddyIP string
|
|
|
|
MailPorts []int // published as-is: 25, 465, 993, 995, 4190
|
|
|
|
// URLs as a browser will use them. Local installs have no proxy and no
|
|
// certificates, so they are the loopback binds instead.
|
|
ServerPublicURL string
|
|
ConsoleURL string
|
|
WebmailURL string
|
|
|
|
ACMEDirectory string
|
|
ACMECARoot string
|
|
CABundle bool
|
|
}
|
|
|
|
// ServerNames is every name the server's certificate and the proxy need:
|
|
// the mail host, and the four service names the server puts in its own
|
|
// certificate by default.
|
|
//
|
|
// The list has to match what the server asks for exactly. Leaving
|
|
// ua-auto-config out of the proxy meant its HTTP-01 challenge was not
|
|
// forwarded, the whole order failed on that one name, and the mail ports
|
|
// served a self-signed certificate while every other name validated.
|
|
func (s Stack) ServerNames() []string {
|
|
names := []string{s.MailHost}
|
|
for _, n := range []string{"autoconfig", "autodiscover", "mta-sts", "ua-auto-config"} {
|
|
names = append(names, n+"."+s.Domain)
|
|
}
|
|
return names
|
|
}
|
|
|
|
// Addresses fills in the private network from the subnet, so the compose file
|
|
// has fixed addresses rather than whatever order the daemon started things in.
|
|
func (s *Stack) Addresses() error {
|
|
ip, network, err := net.ParseCIDR(s.Subnet)
|
|
if err != nil {
|
|
return fmt.Errorf("subnet %q: %w", s.Subnet, err)
|
|
}
|
|
ip = ip.To4()
|
|
if ip == nil {
|
|
return fmt.Errorf("subnet %q is not IPv4", s.Subnet)
|
|
}
|
|
at := func(n byte) string {
|
|
a := make(net.IP, len(ip))
|
|
copy(a, ip)
|
|
a[3] += n
|
|
if !network.Contains(a) {
|
|
return ""
|
|
}
|
|
return a.String()
|
|
}
|
|
s.ServerIP, s.ConsoleIP, s.WebmailIP, s.CaddyIP = at(10), at(11), at(12), at(13)
|
|
if s.ServerIP == "" || s.CaddyIP == "" {
|
|
return fmt.Errorf("subnet %q is too small for the stack", s.Subnet)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Write renders the deployment into dir. It returns the secrets it generated,
|
|
// because the caller has to hand one of them to the server as well.
|
|
type Secrets struct {
|
|
AppSecret string // the webmail's session key
|
|
WebmailOAuth string // the first-party client secret both sides hold
|
|
}
|
|
|
|
// Write takes a pointer because it fills in the private addresses as it
|
|
// goes, and the caller needs them: the mail server is told which addresses
|
|
// the front ends speak from, and passing a copy meant telling it "".
|
|
func Write(dir string, s *Stack) (Secrets, error) {
|
|
sec, err := EnsureSecrets(dir)
|
|
if err != nil {
|
|
return sec, err
|
|
}
|
|
if err := s.Addresses(); err != nil {
|
|
return sec, err
|
|
}
|
|
if s.HostServer {
|
|
// Everything that talks to the server is on the host's network and
|
|
// arrives from loopback, which is the address the server is told to
|
|
// exempt from the auto-ban.
|
|
s.WebmailIP, s.CaddyIP = "127.0.0.1", "127.0.0.1"
|
|
} else if s.WebmailOnHost() {
|
|
s.WebmailIP = "127.0.0.1"
|
|
}
|
|
|
|
funcs := template.FuncMap{"join": strings.Join}
|
|
for name, out := range map[string]string{
|
|
"compose.yaml.tmpl": "compose.yaml",
|
|
"Caddyfile.tmpl": "Caddyfile",
|
|
} {
|
|
if out == "Caddyfile" && !s.Proxy {
|
|
continue
|
|
}
|
|
t, err := template.New(name).Funcs(funcs).ParseFS(templates, "templates/"+name)
|
|
if err != nil {
|
|
return sec, err
|
|
}
|
|
var b strings.Builder
|
|
if err := t.Execute(&b, s); err != nil {
|
|
return sec, fmt.Errorf("%s: %w", name, err)
|
|
}
|
|
if err := os.WriteFile(filepath.Join(dir, out), []byte(b.String()), 0o640); err != nil {
|
|
return sec, err
|
|
}
|
|
}
|
|
|
|
return sec, nil
|
|
}
|
|
|
|
// EnsureSecrets returns the deployment's secrets, generating and writing any
|
|
// that do not exist yet. They are generated once and kept: rewriting the
|
|
// deployment to add or remove a component must not roll the webmail's
|
|
// session key or the OAuth client secret the server was told, because the
|
|
// point of converging is that everything not being changed stays as it was.
|
|
//
|
|
// The secrets live in .env beside the compose file, not in it, so the compose
|
|
// file can be read to somebody, pasted into an issue, or committed. A server
|
|
// on the host reads the one it needs from there too.
|
|
func EnsureSecrets(dir string) (Secrets, error) {
|
|
if err := os.MkdirAll(dir, 0o750); err != nil {
|
|
return Secrets{}, err
|
|
}
|
|
sec := readSecrets(filepath.Join(dir, ".env"))
|
|
var err error
|
|
if sec.AppSecret == "" {
|
|
if sec.AppSecret, err = secret(); err != nil {
|
|
return sec, err
|
|
}
|
|
}
|
|
if sec.WebmailOAuth == "" {
|
|
if sec.WebmailOAuth, err = secret(); err != nil {
|
|
return sec, err
|
|
}
|
|
}
|
|
env := fmt.Sprintf("APP_SECRET=%s\nWEBMAIL_CLIENT_SECRET=%s\n", sec.AppSecret, sec.WebmailOAuth)
|
|
if err := os.WriteFile(filepath.Join(dir, ".env"), []byte(env), 0o600); err != nil {
|
|
return sec, err
|
|
}
|
|
return sec, nil
|
|
}
|
|
|
|
// Empty is whether the stack has nothing to run: a server on the host with no
|
|
// front ends and no proxy here. Then there is no compose project at all.
|
|
func (s Stack) Empty() bool {
|
|
return !s.Server && !s.Console && !s.Webmail && !s.Proxy
|
|
}
|
|
|
|
// Upstreams are where Caddy finds each program: by service name on the
|
|
// project's network, or on loopback when it shares the host's.
|
|
func (s Stack) ServerUpstream() string { return s.pick("server:8080", "127.0.0.1:8081") }
|
|
func (s Stack) WebmailUpstream() string { return s.pick("webmail:8080", "127.0.0.1:8080") }
|
|
func (s Stack) ConsoleUpstream() string { return s.pick("console:8080", "127.0.0.1:8082") }
|
|
|
|
// WebmailOnHost is whether the webmail shares the host's network: beside a
|
|
// server on the host, or joined to one that is only on this machine's
|
|
// loopback, which a container on the project network could not reach.
|
|
func (s Stack) WebmailOnHost() bool {
|
|
return s.HostServer || (s.RemoteServerURL != "" && isLoopback(s.RemoteServerURL))
|
|
}
|
|
|
|
// WebmailServerURL is where the webmail finds the mail server.
|
|
func (s Stack) WebmailServerURL() string {
|
|
switch {
|
|
case s.HostServer:
|
|
return "http://127.0.0.1:8081"
|
|
case s.RemoteServerURL != "":
|
|
return strings.TrimRight(s.RemoteServerURL, "/")
|
|
}
|
|
return "http://server:8080"
|
|
}
|
|
|
|
// ServesServer is whether Caddy here serves the mail server's names: not when
|
|
// the server is on another machine, whose own proxy does.
|
|
func (s Stack) ServesServer() bool { return s.Server || s.HostServer }
|
|
|
|
func isLoopback(url string) bool {
|
|
host := url
|
|
if i := strings.Index(host, "://"); i >= 0 {
|
|
host = host[i+3:]
|
|
}
|
|
host = strings.SplitN(host, "/", 2)[0]
|
|
if h, _, err := net.SplitHostPort(host); err == nil {
|
|
host = h
|
|
}
|
|
host = strings.Trim(host, "[]")
|
|
if host == "localhost" {
|
|
return true
|
|
}
|
|
ip := net.ParseIP(host)
|
|
return ip != nil && ip.IsLoopback()
|
|
}
|
|
|
|
func (s Stack) pick(project, host string) string {
|
|
if s.HostServer {
|
|
return host
|
|
}
|
|
return project
|
|
}
|
|
|
|
// readSecrets recovers what a previous run generated, so a converge keeps
|
|
// them. A missing or unreadable file means a first install, and new ones.
|
|
func readSecrets(path string) Secrets {
|
|
var sec Secrets
|
|
b, err := os.ReadFile(path)
|
|
if err != nil {
|
|
return sec
|
|
}
|
|
for _, line := range strings.Split(string(b), "\n") {
|
|
k, v, ok := strings.Cut(strings.TrimSpace(line), "=")
|
|
if !ok {
|
|
continue
|
|
}
|
|
switch k {
|
|
case "APP_SECRET":
|
|
sec.AppSecret = v
|
|
case "WEBMAIL_CLIENT_SECRET":
|
|
sec.WebmailOAuth = v
|
|
}
|
|
}
|
|
return sec
|
|
}
|
|
|
|
func secret() (string, error) {
|
|
b := make([]byte, 32)
|
|
if _, err := rand.Read(b); err != nil {
|
|
return "", err
|
|
}
|
|
return base64.RawURLEncoding.EncodeToString(b), nil
|
|
}
|