Custom Domain Setup

Das Einrichten einer benutzerdefinierten Domain für Ihre Dockit-Dokumentationsseite trägt zur Etablierung Ihrer Markenidentität bei und sorgt für ein professionelles Erscheinungsbild. Dieser Leitfaden behandelt den gesamten Prozess der Konfiguration benutzerdefinierter Domänen auf verschiedenen Hosting-Plattformen.

Overview

Mit einer benutzerdefinierten Domain können Sie Ihre Dokumentation über Ihre eigene Marken-URL bereitstellen, anstatt über die Standard-Hosting-Provider-Subdomain. Zum Beispiel:

Standard: your-docs.netlify.app oder your-docs.vercel.app
Custom: docs.yourcompany.com or help.yourcompany.com

Prerequisites

Stellen Sie vor dem Einrichten einer benutzerdefinierten Domäne sicher, dass Sie über Folgendes verfügen:

Domänenbesitz: Sie besitzen oder kontrollieren die Domäne, die Sie verwenden möchten
DNS-Zugriff: Möglichkeit, DNS-Einträge für Ihre Domain zu ändern
Bereitgestellte Site: Ihre Dockit-Site ist bereits bereitgestellt und funktioniert
SSL certificate: HTTPS support (usually provided automatically)

Domain Configuration Options

Subdomain Setup (Recommended)

Die Verwendung einer Subdomain ist der gebräuchlichste und empfohlene Ansatz:

docs.yourcompany.com
help.yourcompany.com
support.yourcompany.com
knowledge.yourcompany.com

Root Domain Setup

Sie können auch Ihre Stammdomäne verwenden, dies erfordert jedoch zusätzliche Überlegungen:

yourcompany.com
yourdocs.com

Path-based Setup

Dokumentation aus einem bestimmten Pfad bereitstellen:

yourcompany.com/docs
yourcompany.com/help

Platform-Specific Setup

Netlify Configuration

Step 1: Add Custom Domain in Netlify

Gehen Sie im Netlify-Dashboard zu den Site-Einstellungen Ihrer Site
Navigate to Domain management → Custom domains
Click Add custom domain
Geben Sie Ihre Domain ein (z. B. docs.yourcompany.com)

Step 2: Configure DNS Records

Fügen Sie einen CNAME-Eintrag bei Ihrem DNS-Anbieter hinzu:

Type: CNAME
Name: docs (or your chosen subdomain)
Value: your-site-name.netlify.app
TTL: 3600 (or Auto)

Step 3: Enable HTTPS

Netlify automatically provisions SSL certificates through Let’s Encrypt:

Warten Sie auf die DNS-Weitergabe (bis zu 24 Stunden).
Das SSL-Zertifikat wird automatisch ausgestellt
Force HTTPS redirect in Site Settings → HTTPS

Step 4: Configure _redirects (Optional)

Erstellen Sie eine _redirects-Datei in Ihrem public/-Verzeichnis:

# Force HTTPS
http://docs.yourcompany.com/* https://docs.yourcompany.com/:splat 301!

# Redirect old paths
/old-docs/* /new-docs/:splat 301
/v1/* /latest/:splat 301

# SPA fallback
/*  /index.html  200

Vercel Configuration

Step 1: Add Domain in Vercel

Gehen Sie zu Ihrem Projekt-Dashboard
Navigate to Settings → Domains
Geben Sie Ihre benutzerdefinierte Domäne ein
Wählen Sie den Bereitstellungszweig

Step 2: Configure DNS

Fügen Sie für Subdomains einen CNAME-Eintrag hinzu:

Type: CNAME
Name: docs
Value: cname.vercel-dns.com

Fügen Sie für Stammdomänen A-Einträge hinzu:

Type: A
Name: @
Value: 76.76.19.61

Type: A
Name: @
Value: 76.76.19.62

Step 3: Verify Domain

Vercel verifiziert Ihre Domain automatisch und stellt SSL-Zertifikate aus.

Step 4: Configure vercel.json

{
  "redirects": [
    {
      "source": "/old-path",
      "destination": "/new-path",
      "permanent": true
    }
  ],
  "headers": [
    {
      "source": "/(.*)",
      "headers": [
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Frame-Options",
          "value": "DENY"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        }
      ]
    }
  ]
}

GitHub Pages Configuration

Step 1: Configure Repository Settings

Go to repository Settings → Pages
Select source (usually main branch)
Fügen Sie im Feld Benutzerdefinierte Domäne eine benutzerdefinierte Domäne hinzu

Step 2: Create CNAME File

Erstellen Sie eine CNAME-Datei in Ihrem Repository-Stammverzeichnis oder public/-Verzeichnis:

docs.yourcompany.com

Step 3: Configure DNS

Add a CNAME record pointing to GitHub Pages:

Type: CNAME
Name: docs
Value: yourusername.github.io

Step 4: Enable HTTPS

GitHub Pages stellt automatisch SSL-Zertifikate für benutzerdefinierte Domänen bereit.

Firebase Hosting Configuration

Step 1: Configure firebase.json

{
  "hosting": {
    "public": "dist",
    "site": "your-project-id",
    "cleanUrls": true,
    "trailingSlash": false,
    "rewrites": [
      {
        "source": "**",
        "destination": "/index.html"
      }
    ],
    "headers": [
      {
        "source": "**/*.@(jpg|jpeg|gif|png|svg|webp|js|css)",
        "headers": [
          {
            "key": "Cache-Control",
            "value": "max-age=31536000"
          }
        ]
      }
    ]
  }
}

Step 2: Add Custom Domain

firebase hosting:channel:deploy live --only hosting
firebase hosting:site:get your-project-id

Add domain in Firebase Console:

Go to Hosting section
Click Add custom domain
Befolgen Sie die Verifizierungsschritte

Step 3: DNS Configuration

Fügen Sie die bereitgestellten DNS-Einträge aus der Firebase-Konsole hinzu.

DNS Provider Examples

Cloudflare DNS

Type: CNAME
Name: docs
Content: your-site.netlify.app
Proxy status: Proxied (orange cloud)
TTL: Auto

Additional Cloudflare settings:

SSL/TLS: Full (strict)
Always Use HTTPS: On
Automatic HTTPS Rewrites: On

Google Domains

Type: CNAME
Name: docs
Data: your-site.netlify.app.
TTL: 1 hour

Namecheap DNS

Type: CNAME Record
Host: docs
Value: your-site.netlify.app
TTL: Automatic

Route 53 (AWS)

{
  "Type": "CNAME",
  "Name": "docs.yourcompany.com",
  "Value": "your-site.netlify.app",
  "TTL": 300
}

SSL Certificate Configuration

Automatic SSL (Recommended)

Most modern hosting platforms provide automatic SSL:

Netlify: Let’s Encrypt (automatic)
Vercel: Automatic SSL provisioning
GitHub-Seiten: Automatisch für benutzerdefinierte Domänen
Firebase: Google-managed certificates

Manual SSL Configuration

Für erweiterte Setups benötigen Sie möglicherweise eine manuelle SSL-Konfiguration:

server {
    listen 443 ssl http2;
    server_name docs.yourcompany.com;

    ssl_certificate /path/to/certificate.crt;
    ssl_certificate_key /path/to/private.key;

    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512;
    ssl_prefer_server_ciphers off;

    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

Advanced Configuration

Multiple Domains

Konfigurieren Sie mehrere Domänen für dieselbe Site:

[[redirects]]
  from = "https://old-docs.com/*"
  to = "https://docs.yourcompany.com/:splat"
  status = 301
  force = true

[[redirects]]
  from = "https://help.yourcompany.com/*"
  to = "https://docs.yourcompany.com/:splat"
  status = 301
  force = true

Internationalization Domains

Richten Sie verschiedene Domänen für verschiedene Sprachen ein:

docs.yourcompany.com (English)
docs-de.yourcompany.com (German)
docs-fr.yourcompany.com (French)
docs-es.yourcompany.com (Spanish)

CDN Integration

Konfigurieren Sie CDN für eine bessere Leistung:

{
  "functions": {
    "app/api/**/*.js": {
      "maxDuration": 30
    }
  },
  "regions": ["iad1", "sfo1", "fra1"],
  "github": {
    "enabled": false
  }
}

Security Best Practices

HSTS Configuration

Enable HTTP Strict Transport Security:

Strict-Transport-Security: max-age=31536000; includeSubDomains; preload

Content Security Policy

Content-Security-Policy: default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self' data:; connect-src 'self'; media-src 'self'; object-src 'none'; child-src 'self'; frame-ancestors 'none'; form-action 'self'; base-uri 'self';

Additional Security Headers

X-Content-Type-Options: nosniff
X-Frame-Options: DENY
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Permissions-Policy: geolocation=(), microphone=(), camera=()

Performance Optimization

DNS Optimization

Use fast DNS providers: Cloudflare, Route 53, or Google DNS
Minimize DNS lookups: Reduce external resource dependencies
Enable DNS prefetching: <link rel="dns-prefetch" href="//example.com">

Caching Strategy

# Static assets
Cache-Control: public, max-age=31536000, immutable

# HTML files
Cache-Control: public, max-age=0, must-revalidate

# API responses
Cache-Control: public, max-age=300, s-maxage=600

Monitoring and Analytics

Domain Health Monitoring

Richten Sie die Überwachung für Ihre benutzerdefinierte Domain ein:

// Basic uptime monitoring
async function checkDomainHealth() {
  try {
    const response = await fetch('https://docs.yourcompany.com/health');
    if (response.ok) {
      console.log('Domain is healthy');
    } else {
      console.error('Domain health check failed');
    }
  } catch (error) {
    console.error('Domain is unreachable:', error);
  }
}

setInterval(checkDomainHealth, 300000); // Check every 5 minutes

Analytics Configuration

<!-- Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=GA_TRACKING_ID"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());
  gtag('config', 'GA_TRACKING_ID', {
    custom_map: {
      'custom_parameter': 'dimension1'
    }
  });
</script>

Troubleshooting

Common Issues

DNS Propagation Delays

Es kann bis zu 48 Stunden dauern, bis sich DNS-Änderungen weltweit vollständig verbreiten:

# Check DNS propagation
dig docs.yourcompany.com
nslookup docs.yourcompany.com

Online tools:

whatsmydns.net
dnschecker.org

SSL Certificate Issues

Häufige SSL-Probleme und Lösungen:

Mixed content errors: Ensure all resources use HTTPS
Certificate mismatch: Verify domain names match certificate
Expired certificates: Set up auto-renewal

Redirect Loops

Prevent infinite redirects:

# Incorrect
https://docs.yourcompany.com → https://docs.yourcompany.com

# Correct
http://docs.yourcompany.com → https://docs.yourcompany.com

Performance Issues

Leistungsprobleme diagnostizieren und beheben:

# Test site speed
curl -w "@curl-format.txt" -o /dev/null -s "https://docs.yourcompany.com"

# Check response headers
curl -I "https://docs.yourcompany.com"

Debug Tools

DNS Debugging

# Check A records
dig A docs.yourcompany.com

# Check CNAME records
dig CNAME docs.yourcompany.com

# Check MX records
dig MX yourcompany.com

# Trace DNS resolution
dig +trace docs.yourcompany.com

SSL Debugging

# Check SSL certificate
openssl s_client -connect docs.yourcompany.com:443 -servername docs.yourcompany.com

# Test SSL configuration
curl -vI https://docs.yourcompany.com

Migration Strategies

Zero-Downtime Migration

Planen Sie eine nahtlose Domänenmigration:

Neue Domain vorbereiten: Einrichten und gründlich testen
DNS mit niedriger TTL aktualisieren: Reduzieren Sie die Ausbreitungszeit
Verkehr überwachen: Achten Sie auf etwaige Probleme
Implement redirects: Guide users to new domain
Update internal links: Change all references
Benutzer benachrichtigen: Kommunizieren Sie die Änderung

Migration Checklist

Best Practices

Choose meaningful subdomains: Use clear, descriptive names
Enable HTTPS everywhere: Never serve content over HTTP
Monitor domain health: Set up uptime monitoring
Planen Sie für Katastrophen: Halten Sie Backup-Domänen bereit
Dokumentieren Sie Ihr Setup: Bewahren Sie Konfigurationsaufzeichnungen auf
Regelmäßige Wartung: Konfigurationen überprüfen und aktualisieren
Sicherheit geht vor: Implementieren Sie die richtigen Header und Richtlinien
Leistung zählt: Optimieren Sie für Geschwindigkeit und Zuverlässigkeit

Conclusion

Das Einrichten einer benutzerdefinierten Domäne für Ihre Dockit-Dokumentationsseite verbessert Ihre Markenpräsenz und bietet Ihren Benutzern ein professionelles Erlebnis. Befolgen Sie die plattformspezifischen Anweisungen, implementieren Sie geeignete Sicherheitsmaßnahmen und überwachen Sie den Zustand Ihrer Domain, um die besten Ergebnisse zu erzielen.

Denken Sie daran, gründliche Tests in einer Staging-Umgebung durchzuführen, bevor Sie Änderungen an Produktionsdomänen vornehmen, und halten Sie für den Fall von Problemen immer einen Rollback-Plan bereit.