mirror of
https://github.com/pocket-id/pocket-id.git
synced 2026-09-21 10:29:05 +02:00
FRANCIS_HOST decides where the Francis actor runtime lives. When set to "embedded" (the default), Pocket ID starts the runtime inside its own process. Any other value is the address, or a comma-separated list of addresses, of a standalone Francis runtime. Pocket ID then connects to it as a remote actor host and starts no embedded runtime. Because when using a remote runtime, it's likewise not possible to enforce a single instance of Pocket ID is running at once, the env vars currently have the `EXPERIMENTAL_` prefix, are **undocumented**, and show a warning if used. Notes: - Connecting to a standalone runtime also needs FRANCIS_HOST_PSK or FRANCIS_HOST_JWT_FILE, and optionally (but recommended) FRANCIS_CA. - When connecting to a remote runtime, exporting Pocket ID data does not include the actor state, which will need to be backed up and restored separately
32 lines
1.3 KiB
Go
32 lines
1.3 KiB
Go
package cmds
|
|
|
|
import (
|
|
"archive/zip"
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/pocket-id/pocket-id/backend/internal/service"
|
|
)
|
|
|
|
// printRemoteActorDataNotice warns that the command does not cover the actor data, which a standalone Francis runtime owns rather than Pocket ID
|
|
// It goes to stderr so it stays visible when the archive itself is streamed to stdout
|
|
func printRemoteActorDataNotice(consequence string, remedy string) {
|
|
fmt.Fprintf(os.Stderr, `WARNING: FRANCIS_HOST points to a standalone Francis runtime.
|
|
%s.
|
|
To cover all data, %s.
|
|
|
|
`, consequence, remedy)
|
|
}
|
|
|
|
// ensureNoActorsBackup rejects an archive that carries the actor data when a standalone Francis runtime owns it
|
|
// Such an archive comes from a deployment with an embedded runtime, and restoring only its Pocket ID half would leave the runtime holding actor state belonging to a different deployment
|
|
func ensureNoActorsBackup(zipReader *zip.Reader) error {
|
|
for _, f := range zipReader.File {
|
|
if f.Name == service.ActorsBackupFileName {
|
|
return fmt.Errorf("this archive contains the actor data (%s) but FRANCIS_HOST points to a standalone Francis runtime, which owns that data instead: restore it into a deployment with an embedded runtime, or load the actor data into the runtime with 'francis runtime restore'", service.ActorsBackupFileName)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|