-
Notifications
You must be signed in to change notification settings - Fork 11
Hosted Service
CDOGS is available as a hosted service for BC Government client applications.
To request access, go to the API Services Portal page for CDOGS.
More details on the onboarding process can be found here.
Although the hosted service is sufficient for most needs, hosting your own customized instance of CDOGS may be a better fit in some cases.
For a full list of customizable options, please refer to the environment variables.
Note
Due to storage limits, the hosted service will delete pre-uploaded templates whenever space is needed.
There are no guarantees on how long templates are stored, so we recommend checking whether the template is still available before rendering your document or including the template in the body of each request.
Generated documents are not retained or stored on our server.CDOGS can cache the templates to optimize network traffic. Caching behaviour can be configured via the Carbone environment variables. While there is no explicit variable to explicitly toggle caching support, you may point the cache directory to /dev/null to drop any template caching requests.
Once a template has been cached, anyone with the provided SHA256 hash can download it. If you need to cache your template and have concerns about cached template access, we encourage you to consider hosting your own instance instead of leveraging the hosted service.
Requests to the hosted service must be authenticated via a JWT issued by a specific Keycloak realm integrated with the BC Government API Gateway. Please see the quick start for more details on authentication.
If you wish to authenticate with another Keycloak server or realm (or disable it entirely), this can be done by customizing the Keycloak environment variables in your own install.
Unauthenticated mode is meant to be run in a already-secured network environment with the appropriate firewalls and network policies in place.
While our hosted service is configured to run 2 replicas of CDOGS at any given time, document generation within each of them is single-threaded.
PDFs that take longer than 60 seconds to generate will timeout.
If you are generating very large documents, we kindly ask that you host your own instance so that our hosted service is available for all users.
Return Home