Service: Specter CRM - EyevinnOSC/community GitHub Wiki

Specter CRM

Specter CRM (serviceId svensson00-spectercrm, license Apache-2.0) is a multi-tenant CRM application for managing organizations, contacts and deals, with deduplication, reporting and API integrations. It uses PostgreSQL through the Prisma ORM for storage. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance.

What it can do

  • Manage organizations, contacts and deals in a multi-tenant CRM.
  • Deduplicate records and produce reports.
  • Integrate through an API; the app uses JWT authentication with access and refresh tokens (token rotation on refresh) and a React frontend with an Express backend.
  • Run as your own private CRM instance.

Creating an instance

Create a PostgreSQL 16+ database first (birme-osc-postgresql, see the PostgreSQL page) and confirm it is running. Build the connection URL from describe-service-instance: postgres://postgres:<password>@<IP>:<PORT>/postgres.

Store the secrets with create-service-secret (serviceId svensson00-spectercrm):

  • dburl: the PostgreSQL connection URL, for example postgres://postgres:[email protected]:10505/postgres
  • jwtsecret: a random string for signing access tokens, for example from openssl rand -base64 32
  • refreshsecret: a different random string for signing refresh tokens (different values for the two secrets are recommended for production)

Then call create-service-instance with serviceId: "svensson00-spectercrm":

{
  "name": "mycrm",
  "DatabaseUrl": "{{secrets.dburl}}",
  "JwtSecret": "{{secrets.jwtsecret}}",
  "RefreshTokenSecret": "{{secrets.refreshsecret}}"
}

Wait with wait-for-service-ready or get-instance-status, then open the instance URL and register your first user through the sign-up flow.

Equivalent OSC CLI usage:

osc create birme-osc-postgresql mycrm-db -o PostgresPassword="mypassword"
osc create svensson00-spectercrm mycrm \
  -o DatabaseUrl="postgres://postgres:mypassword@<IP>:<PORT>/postgres" \
  -o JwtSecret="$(openssl rand -base64 32)" \
  -o RefreshTokenSecret="$(openssl rand -base64 32)"

Options

Option Required Type Meaning
name Yes string Name of the instance. Letters, digits and underscore (^\w+$); OSC limits names to 20 characters.
DatabaseUrl Yes string, sensitive PostgreSQL connection string used by Prisma. The application requires PostgreSQL 16+. Associated with birme-osc-postgresql.
JwtSecret No string, sensitive Secret used to sign and verify JWT access tokens. Use a cryptographically random value in production. OSC can generate it.
RefreshTokenSecret No string, sensitive Secret used to sign and verify JWT refresh tokens. Use a random value different from JwtSecret in production. OSC can generate it.
CorsOrigin No string Allowed origins for CORS requests to the API, i.e. which frontend URLs may call the backend. Upstream's CORS_ORIGIN; multiple origins are supported. Not mentioned in the original page example.

Pass the sensitive options as {{secrets.NAME}}, which must be the entire field value.

PostgreSQL options (birme-osc-postgresql)

Option Required Type Meaning
name Yes string Instance name.
PostgresPassword Yes string, sensitive Password for the PostgreSQL superuser, for example {{secrets.postgrespwd}}.
PostgresUser No string Superuser name. Defaults to postgres.
PostgresDb No string Default database created at start. Defaults to the same name as the user.
PostgresInitDbArgs No string Extra arguments passed to initdb (for example encoding or locale).
PostgresInitDbSql No string SQL run during database initialization.

Resources

⚠️ **GitHub.com Fallback** ⚠️