Skip to main content
Version: 1.11.0

Setting up custom routes

Epinio has the idea of a "system domain". You set this domain when installing Epinio (with the global.domain helm value). It must be a wildcard domain and it's used in 2 different cases:

  • To create a URL for the Epinio API server
  • To create URLs for the applications deployed with Epinio (also known as "Routes")

For example, if deploying Epinio with the global.domain set to myawesomedomain.org:

  • The Epinio API would be accessible at https://epinio.myawesomedomain.org
  • An application named "myapp" would be available at: https://myapp.myawesomedomain.org

This requires zero setup for each application. However, sometimes a custom domain is needed, dedicated to the application. For example, assuming that the application must also be available on https://i-own-this-awesome-domain.org.

Add this domain to your application with the command below:

epinio app update sample --route i-own-this-awesome-domain.org

This removes the original route. To keep it, it has to be explicitly specified:

epinio app update sample --route i-own-this-awesome-domain.org --route myapp.myawesomedomain.org

The --route parameter can also be passed when the app is first pushed:

epinio app push -n sample -p . --route myapp.myawesomedomain.org

Epinio tries to create a TLS certificate for any defined route, as it does for the wildcard system domain ones. Depending on the issuer used, DNS may have to work before the domain can be correctly used. In other words, the domain must fully resolve to the cluster's Ingress IP. You can read more about issuers at Certificate Issuers.