This is an API server meant to be a backend for issuing Verifiable Credentials
For dev use you'll need node.js, mkcert and docker-compose
Configure SSL certs for the local docker instances, you should only have to do this once
mkcert -install
to install a local CAmkcert -cert-file ~/certs/127.0.0.1.nip.io.crt -key-file ~/certs/127.0.0.1.nip.io.key '*.127.0.0.1.nip.io'
echo export NODE_EXTRA_CA_CERTS="$(mkcert -CAROOT)/rootCA.pem" | tee -a ~/.bashrc ~/.zshrc && exec $0
to add the local CA to your environmentNow you can build and start the server by:
docker-compose up --build
, if you get an error that a port is in use you're probably already running a web server or db on your machine, you'll have to either stop it or adjust the ports used by this project in docker-compose.override.yml
Authorize
button near the top of the page and enter Bearer xyz
where xyz
is the admin token you noted earlierAll configuration is done through environment variables.
Variable | Default | Description |
---|---|---|
CA_DB_CONNECTION_URL | Database connection URL | |
CA_JWT_SECRET | secret | Secret used when signing JWTs for user auth |
OIDC_COMPARE | sub | OIDC userInfo field to compare to externalIds |
OIDC_ISSUER_URL | URL of OIDC server | |
OIDC_USERINFO_PATH | /userinfo | Path to the userinfo endpoint of OIDC server |
PORT | 3000 | Port to listen for http requests on |
PUBLIC_URL | Publicly reachable URL for this server | |
TEMPLATE_URL | local://templates | URL to retrieve templates from using @tweedegolf/storage-abstraction" |