Skip to content
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.

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

docs: Update domains page to include custom domain details #151

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
60 changes: 54 additions & 6 deletions docs/deployments/domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,62 @@
title: Domains
---

A domain is the address of your deployment.
A domain is the address used to access your Globe-hosted project. By default, each project is assigned a unique domain (e.g., `your-project.globe.com`). You can also link a custom domain to your project for a branded experience.

Each deployment, production or preview gets assigned a unique domain that directly points to the specific deployment. If the deployment is not yet ready or successful, visiting a domain will redirect you to the dashboard for that deployment.
## Linking a Custom Domain

## Production domains
Custom domains allow you to connect your branded URL (e.g., `your-company.com`) to your Globe-hosted project. This makes your project accessible on a domain of your choice.

Each project gets assigned a unique domain when it is created. Whenever you successfully deploy to the production environment, the production domain will be updated to point to the latest deployment.
### How It Works

### Custom Domains
1. Register a domain with an external provider (e.g., Namecheap, GoDaddy, Google Domains).
2. Configure your DNS settings to point to Globe.
3. Add your domain to a project via the Globe Dashbord.
4. Cloudflare handles DNS management and security, including automatic SSL (HTTPS).

Custom domains are not yet supported. We are working on it.
## Setting Up Your Custom Domain

### Step 1: Configure DNS with Your Registrar

Before adding a custom domain to Globe, update your DNS settings with your domain provider (e.g., GoDaddy, Google Domains, Cloudflare).

- Add a **CNAME record** pointing your domain to `domains.globeapp.dev`.
- Follow your provider’s setup instructions.

Once updated, add your domain in the Globe Dashboard and verify it.

### Step 2: Add Your Domain in Globe

1. Go to the **Globe Dashboard**.
2. Navigate to **Domains**.
3. Select **Add Domain**.
4. Enter your domain name (e.g., `example-app.com`).
5. Select **Verify**.

### Step 3: Verify Your Domain

After you add your domain, Cloudflare will attempt to verify it. The domain status may change as the setup progresses:

- **Active** – The domain is linked, and SSL is enabled.
- **Pending Verification** - DNS changes are still updating. This can take up to 24 hours.
- **Verification Failed** – DNS records are missing or incorrect. Check your DNS settings and try again.

## Removing or Changing a Domain

To remove a domain:

1. Go to **Domains**.
2. Select the existing domain.
3. Select **Remove Domain**.

Once removed, follow the setup steps above to add a new domain.

## Troubleshooting

If you run into errors when adding or verifying a domain, try the following:

- **Check your DNS settings** with your domain provider. Make sure required records exist and are correct.
- **Remove and re-add the domain** in Globe. This can fix temporary connection errors.
- **Wait up to 24 hours** if your domain was recently updated. DNS changes can take time to propagate.
- **Review [Cloudflare’s Troubleshooting Guide](https://developers.cloudflare.com/dns/troubleshooting/)** for help with DNS-specific errors.
- Ask for help on Globe's [Discord](https://discord.gg/UCcCYjDaTy).
Loading