chore/docs: move to GitHub as the single home; drop archived-spec references
Codeberg is being retired as the project's public site, so every reference now points at GitHub. That includes the Go module path (codeberg.org/mix/selfpost → github.com/mixeme/selfpost): leaving an import path on a host that is going away would break `go get` and `go install`, so this is not only a docs change. Touches go.mod, test/e2e/go.mod, all imports, Makefile MODULE, the -ldflags version stamp in build/Dockerfile and docs/development.md, the licence headers in the SVG/HTML assets, and README (no more primary/mirror pair). Comments no longer cite the archived specification. "spec 7.6.1", "spec 5.1" and friends pointed into docs/archive/specification-v1.0.md, which is marked as not a source of truth; each is now a reference to the live document that owns the subject — architecture.md (with section), product.md, security.md or the README. The review only asked for the 7.x refs (code-review.md § 4), but 4/5/6/ 8/9 had the same defect, so they went too. Comments only, no behaviour change. Also closes the remaining review items: architecture.md gained a Code layers section with the layer diagram (A2), and TestParseDelivery gained the exotic mail.log cases (§ 3). Fixes a bug that last test found: the delivery-line pattern matched status= greedily, taking the *last* occurrence on the line. Postfix appends the remote server's reply verbatim, so a rejection whose reply quoted "status=sent" was filed as a delivered message in the send log. It now takes the first status= after the recipient, which is the real field. R7 (CONTRIBUTING.md) moved to roadmap 2.x — one developer, no external PR flow, so the file would have no audience yet. R1 (compose image tag) and the git tag stay in roadmap § v1.x as the release-commit steps. gofmt/go vet clean on both modules; go test ./... green except the three known Windows-only failures (file perms, backslash paths, renaming an open file). Not exercised on the dev server — no Docker locally. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
+22
-20
@@ -3,19 +3,20 @@ package domain
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"codeberg.org/mix/selfpost/internal/buildinfo"
|
||||
"codeberg.org/mix/selfpost/internal/store"
|
||||
"github.com/mixeme/selfpost/internal/buildinfo"
|
||||
"github.com/mixeme/selfpost/internal/store"
|
||||
)
|
||||
|
||||
// FormatDomainExport identifies a single-domain export file (spec 7.5.B).
|
||||
// FormatDomainExport identifies a single-domain export file (architecture.md §
|
||||
// Persistence).
|
||||
const FormatDomainExport = "selfpost-domain-export"
|
||||
|
||||
// DomainExport is the serialisable form of one sending domain, for moving it
|
||||
// between two independently running SelfPost instances (spec 7.5.B). It carries
|
||||
// the DKIM private key (so the published DNS record stays valid) and each
|
||||
// application's working password (so credentials transfer without regeneration).
|
||||
// The file is therefore as sensitive as a full backup and must be handled as a
|
||||
// secret.
|
||||
// between two independently running SelfPost instances (architecture.md §
|
||||
// Persistence). It carries the DKIM private key (so the published DNS record
|
||||
// stays valid) and each application's working password (so credentials
|
||||
// transfer without regeneration). The file is therefore as sensitive as a full
|
||||
// backup and must be handled as a secret.
|
||||
type DomainExport struct {
|
||||
Format string `json:"format"`
|
||||
Version string `json:"version"`
|
||||
@@ -35,8 +36,8 @@ type AppExport struct {
|
||||
|
||||
// Export builds the transferable representation of a domain: its DKIM key, its
|
||||
// selector and every application with its address mode and working password
|
||||
// (spec 7.5.B). The returned struct is marshalled to JSON by the caller and
|
||||
// offered as a secret download.
|
||||
// (architecture.md § Persistence). The returned struct is marshalled to JSON
|
||||
// by the caller and offered as a secret download.
|
||||
func (s *Service) Export(id int64) (DomainExport, error) {
|
||||
d, err := s.store.GetDomain(id)
|
||||
if err != nil {
|
||||
@@ -73,17 +74,18 @@ func (s *Service) Export(id int64) (DomainExport, error) {
|
||||
return exp, nil
|
||||
}
|
||||
|
||||
// Import re-creates a domain from an export file on this instance (spec 7.5.B):
|
||||
// it stores the imported DKIM key (so the published DNS record needs no change),
|
||||
// registers the domain and rebuilds the OpenDKIM tables, then re-creates each
|
||||
// application with its working password and rebuilds the Postfix sender map.
|
||||
// Import re-creates a domain from an export file on this instance
|
||||
// (architecture.md § Persistence): it stores the imported DKIM key (so the
|
||||
// published DNS record needs no change), registers the domain and rebuilds the
|
||||
// OpenDKIM tables, then re-creates each application with its working password
|
||||
// and rebuilds the Postfix sender map.
|
||||
//
|
||||
// exp.Domain must already be normalised and validated by the caller (spec
|
||||
// 7.6.2); the selector is checked for config-injection safety here. A domain or
|
||||
// login that already exists is rejected (store.ErrDomainExists /
|
||||
// store.ErrLoginExists) rather than merged. If any step fails, everything the
|
||||
// import created is rolled back, so a partial import never leaves the instance
|
||||
// in an inconsistent state.
|
||||
// exp.Domain must already be normalised and validated by the caller
|
||||
// (security.md); the selector is checked for
|
||||
// config-injection safety here. A domain or login that already exists is
|
||||
// rejected (store.ErrDomainExists / store.ErrLoginExists) rather than merged.
|
||||
// If any step fails, everything the import created is rolled back, so a
|
||||
// partial import never leaves the instance in an inconsistent state.
|
||||
func (s *Service) Import(exp DomainExport) (store.Domain, error) {
|
||||
if exp.Format != FormatDomainExport {
|
||||
return store.Domain{}, fmt.Errorf("not a SelfPost domain export (format %q)", exp.Format)
|
||||
|
||||
Reference in New Issue
Block a user