quick start
HOW TO
Auth
App Management
Microservices
How to set up a custom domain
Introduction
Skygear provides default suffixed domain
.skygearapp.com for you to access your application. You can update your application to use a custom domain which owned by you instead of the skygear generated domain. Prerequisites
To setup custom domain, you need to install and configure
skycli properly. Please follow this guide to setup skycli.Setup custom domain
1. Add custom domain
1
$ skycli domain add <your_domain>
2
​
3
#example
4
$ skycli domain add www.example.com --app=myapp
Copied!
2. Verify domain ownership
Add DNS records in your DNS provider
After adding the custom domain, please follow the instructions shown in the console and add dns records in your dns provider.
1
#exmaple
2
$ skycli domain add www.example.com --app=myapp
3
Added domain www.example.com successfully!
4
​
5
Add following DNS records in your DNS provider.
6
​
7
TYPE HOST VALUE
8
TXT _skygear.example.com <txt_record_value>
9
A www.example.com <a_record_value>
10
​
11
After updating DNS records, run `skycli domain verify www.example.com` to verify domain.
Copied!
Ask Skygear Cluster to verify the domain
1
$ skycli domain verify <your_domain>
2
​
3
#example
4
$ skycli domain verify www.example.com --app=myapp
5
Success! You can now access your app through www.example.com.
6
Your site may show a security certificate warning until the certificate has been provisioned.
Copied!
After verifying the domain successfully, you can now access your application with the new domain.
3. (Optional) Setup custom certificate
Skygear Cluster by default provisions SSL certificate signed by Let's Encrypt. If you want to use your own certificate, you can update it with
skycli domain update command.1
# Create tls secret
2
$ skycli secret create <your_tls_secret_name> --type=tls --cert=<path/to/tls-cert.pem> --key=<path/to/tls-key.pem>
3
# Update domain to use tls secret
4
$ skycli domain update <your_domain> --tls-secret=<your_tls_secret_name>
5
​
6
​
7
#example
8
$ skycli secret create myapp-tls --type=tls --cert=path/to/tls-cert.pem --key=path/to/tls-key.pem --app=myapp
9
Success! Created secret myapp-tls
10
​
11
$ skycli domain update example.com --tls-secret=myapp-tls --app=myapp
12
Success! Updated domain example.com
13
​
14
$ skycli domain list --app=myapp
15
DOMAIN VERIFIED CUSTOM_CERT REDIRECT SSL_CERT_EXPIRY CREATED_AT
16
example.com true true - 2020-11-26 20:00:00 +08:00 2020-01-01 18:00:00 +08:00
Copied!
4. (Optional) Setup redirect
For some case, you may want to redirect all requests of a custom domain to another specific domain (e.g. Redirect
example.com to www.example.com).1
$ skycli domain update example.com --redirect-domain=www.example.com
2
Success! Updated domain example.com
3
​
4
$ skycli domain list --app=myapp
5
DOMAIN VERIFIED CUSTOM_CERT REDIRECT SSL_CERT_EXPIRY CREATED_AT
6
www.example.com true false - - 2019-11-26 18:00:00 +08:00
7
example.com true false www.example.com - 2019-11-26 18:00:00 +08:00
Copied!
​