Skip to content

fix: use ALIAS records for top level custom domains #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
janb87 merged 3 commits into from
Oct 9, 2024
Merged

fix: use ALIAS records for top level custom domains #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b5e5e7
fix: use ALIAS records for top level custom domains
janb87 Oct 8, 2024
0cedfff
fix: use ALIAS dns records for top level domains
janb87 Oct 9, 2024
81df9fe
improve docs
janb87 Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/about-settlemint/4_components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ of any business logic included in your integration.

## Add a Custom Deployment


Your blockchain application may require custom components or frontend applications that are not provided by the standard SettleMint platform offerings. The [Custom Deployment](../../using-platform/custom-deployment/) feature allows you to deploy your own Docker images on the SettleMint platform. This provides the flexibility to integrate custom solutions, such as frontend applications, within your blockchain-based projects, enhancing the overall functionality and user experience of your application.

## Getting Started
Expand Down
34 changes: 20 additions & 14 deletions docs/using-platform/24_custom-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,35 +23,41 @@ When using custom domains with your Custom Deployment, you'll need to configure

1. **Add Custom Domain to the SettleMint Platform**:
- Navigate to your Custom Deployment in the SettleMint platform.
- In the manager custom deployment menu, click on the edit custom deployment action
- Locate the custom domains configuration section
- Enter your desired custom domain (e.g., example.com or app.example.com).
- In the manage custom deployment menu, click on the edit custom deployment action.
- Locate the custom domains configuration section.
- Enter your desired custom domain (e.g., example.com for top-level domain or app.example.com for subdomain).
- Save the changes to update your Custom Deployment settings.

2. **Obtain Your Application's Hostname**: After adding your custom domain, the SettleMint platform will provide you with a CNAME record. This can be found in the "Connect" tab of your Custom Deployment.
2. **Obtain Your Application's Hostname**: After adding your custom domain, the SettleMint platform will provide you with an ALIAS (for top-level domains) or CNAME (for subdomains) record. This can be found in the "Connect" tab of your Custom Deployment.

3. **Access Your Domain's DNS Settings**: Log in to your domain registrar or DNS provider's control panel.

4. **Create DNS Records**:
- Create a CNAME record pointing your custom domain to the provided hostname.
- Example: `CNAME example.com your-app.settlemint-platform.com`
4. **Configure DNS Records**:

5. **Configure Subdomains (Optional)**:
- If you want to use subdomains, create additional CNAME records as needed.
- Example: `CNAME app.example.com your-app.settlemint-platform.com`
For Top-Level Domains (e.g., example.com):
- Remove any existing A and AAAA records for the domain you're configuring.
- Remove any existing A and AAAA records for the www domain (e.g., www.example.com) if you're using it.
- Create ALIAS records pointing your custom domain to the provided hostname.
- Example: `ALIAS example.com gke-europe.settlemint.com` and `ALIAS www.example.com gke-europe.settlemint.com`

6. **Set TTL (Time to Live)**:
For Subdomains (e.g., app.example.com):
- Create a CNAME record pointing your subdomain to the provided hostname.
- Example: `CNAME app.example.com gke-europe.settlemint.com`

5. **Set TTL (Time to Live)**:
- Set a lower TTL (e.g., 300 seconds) initially to allow for quicker propagation.
- You can increase it later for better caching (e.g., 3600 seconds).

7. **Verify DNS Propagation**:
6. **Verify DNS Propagation**:
- Use online DNS lookup tools to check if your DNS changes have propagated.
- Note that DNS propagation can take up to 48 hours, although it's often much quicker.

8. **SSL/TLS Configuration**:
- The SettleMint platform typically handles SSL/TLS certificates automatically.
7. **SSL/TLS Configuration**:
- The SettleMint platform typically handles SSL/TLS certificates automatically for both top-level domains and subdomains.
- If you need to use your own certificates, please contact us for assistance and further instructions.

Note: The configuration process is similar for both top-level domains and subdomains. The main difference lies in the type of DNS record you create (ALIAS for top-level domains, CNAME for subdomains) and whether you need to remove existing records.

## Limitations and Considerations

When using Custom Deployment, keep the following limitations in mind:
Expand Down