Omleidingen en Herschrijvingen Configureren

Orbit heeft een ingebouwde engine voor doorsturen en herschrijven die wordt uitgevoerd voordat uw project om iets wordt gevraagd. Deze kan worden geconfigureerd in KPanel of als een bestand in uw opslagplaats. Deze handleiding behandelt beide methodes, de patroon syntaxis en de captures, hoe regels worden geordend, de limieten en het gedrag dat mensen voor problemen kan stellen.

Waar regels configureren

Er zijn twee locaties, en deze worden in een vaste volgorde geëvalueerd.

1. In KPanel. Open uw project in Orbit, ga naar Settings en scroll naar de sectie redirects and rewrites voor de omgeving. Elke omgeving heeft zijn eigen onafhankelijke set regels, dus production en staging worden apart geconfigureerd.
2. In uw opslagplaats, als een kaps.json bestand. Dit wordt verder hieronder behandeld.

Panel-regels worden eerst geëvalueerd. Als geen van deze overeenkomt, worden de kaps.json regels geprobeerd.

Een regel toevoegen in KPanel

1. Klik op Add rule.
2. Vul het source in, het padpatroon om inkomende verzoeken tegen af te stemmen. De placeholder toont de twee vormen die het verwacht: /old-path or /blog/:slug.
3. Vul het destination in. De placeholder toont /new-path or https://..., dus zowel een lokaal pad als een volledige externe URL zijn geldig.
4. Kies het regeltype:
   • 301 Permanent: de URL is permanent verplaatst. Browsers en zoekmachines cachen dit.
   • 302 Temporary: voor nu verplaatst, niet gecached. Gebruik voor campagnes en experimenten.
   • Rewrite: serveer het doelpad zonder de URL in de adresbalk van de browser te veranderen.
5. Klik op Save rules.

Bronpadpatronen

Het verschil tussen :id en :rest* is het belangrijke. Een benoemde parameter komt overeen met een enkel segment en stopt bij de volgende schuine streep. Een splat komt overeen met alles wat overblijft, inclusief schuine strepen.

Captures in de bestemming gebruiken

Verwijs naar een benoemde parameter op naam en naar een kale wildcard als *:

Regelvolgorde

Regels worden van boven naar beneden getest en de eerste overeenkomst wint. Zodra een regel overeenkomt, wordt geen latere regel in aanmerking genomen. Het panel zegt dit onder de lijst: "Rules are tested in order. First match wins."

Als geen regel overeenkomt, wordt het verzoek normaal geserveerd.

Veel voorkomende use cases

Een pagina hernoemen

U hebt /about-us hernoemd naar /about en wilt dat oude koppelingen blijven werken.

• Bron: /about-us
• Bestemming: /about
• Type: 301 Permanent

Een hele sectie verplaatsen

Uw blog is verplaatst van /news/:slug naar /blog/:slug.

• Bron: /news/:slug
• Bestemming: /blog/:slug
• Type: 301 Permanent

Een API-pad stilzwijgend doorsturen

U wilt /api/v1/* geserveerd van een ander intern pad zonder de wijziging bloot te stellen.

• Bron: /api/v1/:path*
• Bestemming: /api/internal/:path*
• Type: Rewrite

Een tijdelijke verhoudingspagina

• Bron: /checkout
• Bestemming: /maintenance
• Type: 302 Temporary

Verkeer naar een ander domein sturen

De bestemming kan een absolute URL zijn, dus een regel kan naar een volledig ander domein verwijzen.

• Bron: /shop/:rest*
• Bestemming: https://shop.example.com/:rest*
• Type: 301 Permanent

Configuratie als code met kaps.json

Regels kunnen in uw opslagplaats staan in plaats van in het paneel. Voeg een kaps.json bestand toe en zorg ervoor dat uw build deze in uw output directory kopieert, omdat Orbit dit uit de wortel van het gebouwde artefact leest, niet uit de opslagplaats wortel.

{
  "redirects": [
    { "source": "/about-us", "destination": "/about", "permanent": true },
    { "source": "/news/:slug", "destination": "/blog/:slug", "permanent": true },
    { "source": "/promo", "destination": "/spring-sale", "permanent": false }
  ],
  "rewrites": [
    { "source": "/api/v1/:path*", "destination": "/api/internal/:path*" }
  ],
  "headers": [
    {
      "source": "/*",
      "headers": [
        { "key": "X-Frame-Options", "value": "DENY" },
        { "key": "X-Content-Type-Options", "value": "nosniff" }
      ]
    }
  ]
}

permanent: true produceert een 301 en permanent: false een 302. Weglaten geeft een 301.

Limieten

• Tot 100 doorstuur- en herschrijvingsregels per omgeving, en 100 in een kaps.json.
• Tot 200 aangepaste headerregels per omgeving.

Regels boven de limiet worden stilzwijgend verwijderd en niet genegeerd, dus blijf er goed onder.

Aangepaste antwoordheaders

Naast doorsturen heeft elke omgeving een antwoordheaders sectie in Settings voor het injecteren van HTTP-headers op overeenkomende paden. Het gebruikt dezelfde padpatroon syntaxis, en er zijn sneltoevoeging voorinstellingen voor HSTS, CSP, no-embed, no-sniff, referrer policy en CORS.

In tegenstelling tot doorsturen worden alle overeenkomende headerregels toegepast, niet alleen de eerste, en een latere regel overschrijft een eerdere regel wanneer zij dezelfde header instellen. Content-Length, Transfer-Encoding en Connection zijn geblokkeerd, omdat het instellen ervan de respons zou beschadigen.

Gedrag dat het waard is te kennen voordat je het gebruikt

• Regels komen alleen overeen met het pad. Fragmenten (#section) bereiken de server helemaal niet, de browser voegt ze na een doorstuur opnieuw in.
• Een herschrijving naar een pad dat niet bestaat, levert een 404 op, in plaats van stilzwijgend terug te vallen op het originele pad. Herschrijfdoelen moeten in uw build-uitvoer bestaan.
• Regels worden uitgevoerd voordat uw project om iets wordt gevraagd, dus zij zijn van toepassing op statische bestanden en op server-modeverzoeken.
• Elke omgeving is onafhankelijk. Regels op production zijn niet van toepassing op staging of previews. Kopieer ze opzettelijk.

Een regel verwijderen

Klik op het prullenbak pictogram in de regelrij, klik vervolgens op Save rules om de wijziging toe te passen. Net als bij het toevoegen van een regel wordt de wijziging van kracht na de volgende implementatie.

Wanneer u in plaats daarvan een edge function moet gebruiken

De doorstuurengine behandelt pad-naar-pad regels. Gebruik een edge function wanneer u logica nodig hebt die de regelmotor niet kan uitdrukken: vertakking op basis van een header of cookie, het behouden of herschrijven van queryparameters, gewogen A/B routing, of iets voorwaardelijks.

Gerelateerde informatie

• Edge Functions
• Een aangepast domein aan uw project toevoegen
• Uw project implementeren