An open API service indexing awesome lists of open source software.

https://github.com/encoredev/placeholder-service

Placeholder service used as an initial deployment image when new compute infrastructure is provisioned
https://github.com/encoredev/placeholder-service

encore go golang

Last synced: over 1 year ago
JSON representation

Placeholder service used as an initial deployment image when new compute infrastructure is provisioned

Awesome Lists containing this project

README

          



Encore – The Backend Development Engine


# Placeholder Service

This is a placeholder service which Encore will use as an initial deployment image when new compute infrastructure is
provisioned on the cloud. It serves a dual purpose of:

1. Responding with a 200 OK to health checks made by the cloud provider & Encores' platform to verify the compute
infrastructure is ready and routable from the public internet.
2. Responding with a 404 to all other requests with a human-readable error that the service has not been deployed yet.
This is to prevent user confusion when they attempt to access the service before it has been deployed.

### Configuration

Configuration can be done from either environmental variables, a `.env` file within the working directory or a `config.yaml`
file in the working directory, `/etc/encore/placeholder-service` or `/$HOME/.encore/placeholder-service`.

See [example.env](./example.env) for a list of the configuration options and the documentation for each.