customer-os-api

command module
v0.0.0-...-946920c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 27, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

README

Customer OS Base Model

Env vars

Name Meaning
PORT optional, specify the port of the api, defaults to 10000
GRAPHQL_PLAYGROUND_ENABLED enables the graphql playground,a graphical, interactive, in-browser GraphQL IDE, optional, default faluse
NEO4J_TARGET REQUIRED url to connect to the neo4j database, must start with the neo4j:// prefix
NEO4J_AUTH_USER REQUIRED username to connect to the neo4j database
NEO4J_AUTH_PWD REQUIRED passowrd to connect to neo4j database
NEO4J_AUTH_REALM specify a Neo4J realm (optional, can be set to empty string)
NEO4J_MAX_CONN_POOL_SIZE Neo4j connection pool size, optional defaults to 100

Adding new users (local development)

A script is available in

/deployment/scripts/neo4j

run

./adduser.sh

from that directory

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
graph
@openapi 3.0.0
@openapi 3.0.0
billing
@openapi 3.0.0
@openapi 3.0.0
customerbase
@openapi 3.0.0
@openapi 3.0.0
enrich
@openapi 3.0.0
@openapi 3.0.0
mailstack
@openapi 3.0.0
@openapi 3.0.0
outreach
@openapi 3.0.0
@openapi 3.0.0
verify
@openapi 3.0.0
@openapi 3.0.0
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL