GoodMem
ReferenceCLI

System Install

System Install CLI command reference

goodmem system install

Install the goodmem server

Synopsis

Install GoodMem server with either a local PostgreSQL database or connect to a remote database.

By default, installs with a local PostgreSQL database running in Docker. Use --remote-db flags to connect to an existing PostgreSQL instance.

goodmem system install [flags]

Examples

  # Install with local database (default)
  goodmem system install

  # Install with remote database using DSN
  goodmem system install --remote-db --db-url "postgresql://user:pass@host:5432/goodmem"

  # Install with remote database using individual flags
  goodmem system install --remote-db --db-url "host:port/goodmem" --db-user myuser --db-password mypass

  # Install to custom directory
  goodmem system install --dir /opt/goodmem

  # Install with TLS configuration
  goodmem system install --tls-cert /path/to/cert.pem --tls-key /path/to/key.pem

  # Skip Docker installation (if already installed)
  goodmem system install --skip-docker-install

Options

      --checkmark-logger      Use simple checkmark logger (recommended for CI/CD environments)
      --db-password string    Database password (if not in URL)
      --db-url string         Database URL (format: postgresql://user:pass@host:port/db or host:port/db)
      --db-user string        Database username (if not in URL)
      --debug                 Enable debug logging
      --dir string            Installation directory for GoodMem (default "/.goodmem")
      --handsfree             Non-interactive mode - use only flags, no prompts
  -h, --help                  help for install
      --image string          Docker image to use for GoodMem server (default: ghcr.io/pair-systems-inc/goodmem/server:latest)
      --no-sudo               Run commands without sudo (useful in containerized environments where running as root)
      --platform string       Target platform (auto-detected, override only for cross-platform scenarios) (default "linux-amd64")
      --remote-db             Use remote PostgreSQL database instead of local container
      --skip-docker-install   Skip automatic Docker installation (assumes Docker is already installed)
      --skip-verify           Skip Docker image signature verification (for testing/development)
      --tls-cert string       Path to TLS certificate file
      --tls-disabled          Disable TLS for server connections
      --tls-key string        Path to TLS private key file

Options inherited from parent commands

      --api-key string   API key for authentication (can also be set via GOODMEM_API_KEY environment variable)
      --server string    GoodMem server address (gRPC API) (default "https://localhost:9090")

SEE ALSO