Qovery Domains (default)
Your application is publicly accessible via a Qovery domain as soon as you define it to be publicly accessible in
application:name: myappproject: testpublicly_accessible: true
To get the domain that was assigned to your application, use the CLI:
$ qovery status
BRANCHES NAME STATUS ENDPOINTS APPLICATIONS DATABASES BROKERS STORAGEmaster up and running https://xxx-main-gtw.qovery.io 1 1 0 0APPLICATIONS NAME STATUS ENDPOINTS DATABASES BROKERS STORAGEsimple-example up and running https://yyy-xxx-app.qovery.io 1 0 0
You can use a custom domain name for any of your applications. Additionally, the domain name can be different in each environment (branch).
Here is the overview of the process in order to give you the big picture. Each step is then totally detailed on the next sections.
- Create a Qovery custom domain --> To be done on Qovery
- Retrieve Qovery validation domain --> To be done on Qovery
- Create CNAME record on the DNS --> To be done on your DNS provider
- Check verification status of the Qovery custom domain is "live" --> To be done on Qovery side
So basically you do not have to make any complicated configuration on your end, Qovery handles almost everything, except for the CNAME record to create on your DNS provider.
Create a Qovery custom domain
You will have to specify your custom domain in your qovery.yml file:.qovery.yml...routers:- name: maincustom_domains:- branch: masterdomain: my.domain.tldroutes:- application_name: simple-example-node-with-postgresqlpaths:- /
Adding the highlighted lines like in the configuration file above exposes your application using your domain. Now commit and push your changes.
Retrieve Qovery validation domain
In order to see the custom domain you just created, execute the command
qovery domain listto list all domains of your environment:List domainsqovery domain listOUTPUTBRANCH | DOMAIN | STATUS | VALIDATION DOMAIN | ROUTER NAMEmaster | my.domain.tld | validation pending | xxx-yyy-zzz.acme.com | mainmaster | https://main-yenr7erjbs87dk4m-gtw.qovery.io | live | none | my-second-router
As you can see, your newly created domain is in status "validation pending". In order for it to be live and be able to use it, you have to confirm that it is yours, and create a CNAME record on your DNS provider. For this you will need the VALIDATION DOMAIN value, in our case: xxx-yyy-zzz.acme.com.
Create CNAME record on the DNS
Please go to your DNS provider interface and add a
CNAMErecord that is targeting the
xxx-yyy-zzz.acme.comyou just retrieved before.
Check verification status of the Qovery custom domain
After you added the CNAME record on your DNS, it takes Qovery a few minutes to verify and complete the process. In order to know if your custom domain is live or not, you can check the verification status using
qovery domain list.List domainsqovery domain listOUTPUTBRANCH | DOMAIN | STATUS | VALIDATION DOMAIN | ROUTER NAMEmaster | my.domain.tld | live | xxx-yyy-zzz.acme.com | mainmaster | https://main-yenr7erjbs87dk4m-gtw.qovery.io | live | none | my-second-router
If the status is live, then you are all set!
Please note that from the Web UI you can find the custom domains associated to your app by going to the Summary tab of the concerned application page. They will be listed in the "Custom domains" section: