Hosting su sottopercorso
Ospita la documentazione in un sottopercorso del tuo dominio, con configurazioni per Vercel, CloudFront, Cloudflare e proxy inversi.
Ospita la documentazione in un sottopercorso del tuo dominio invece che in un sottodominio separato. Il valore predefinito è yoursite.com/docs, ma puoi scegliere un segmento personalizzato, come yoursite.com/help. Consulta Panoramica del deploy per tutte le opzioni di deploy.
Gli screenshot mostrano l'interfaccia in inglese.
Perché usare un sottopercorso?
Un sottopercorso mantiene i lettori sul tuo dominio principale. Le pagine della documentazione contribuiscono all'autorevolezza del tuo dominio nei motori di ricerca. Un sottodominio come docs.yoursite.com distribuisce i segnali di posizionamento tra due host.
Come funziona
Il tuo server web o CDN inoltra le richieste da /docs/* al tuo sito Jamdesk. Il browser mantiene l'URL originale:
Il proxy invia l'header X-Jamdesk-Forwarded-Host con il tuo dominio. Jamdesk lo usa per:
- Verificare che il tuo dominio sia autorizzato a pubblicare i contenuti
- Applicare la tua configurazione dal dashboard
La configurazione del proxy si imposta una sola volta. Le modifiche al dashboard non richiedono aggiornamenti del proxy.
Configurazione per provider
Prerequisiti
Segui questi passaggi prima di configurare il proxy:
- Aggiungi il tuo dominio nel dashboard di Jamdesk, alla voce Settings → Custom Domain
- Attiva "Host at a subpath"
- Scegli il sottopercorso (facoltativo; vedi Scegliere il sottopercorso qui sotto) e fai clic su Save
Il dashboard mostra il tuo sottodominio Jamdesk (ad esempio, acme.jamdesk.app). Ti servirà per configurare il proxy.
Salvare una modifica all'hosting su sottopercorso avvia una ricompilazione completa della documentazione. Questo vale sia per l'attivazione o la disattivazione, sia per la modifica del sottopercorso. La struttura degli URL cambia (ad esempio, da /introduction a /docs/introduction).
Scegliere il sottopercorso
Per impostazione predefinita, la documentazione è disponibile su /docs. Inserisci un altro valore, come /help o /support, nel campo del sottopercorso accanto all'interruttore. Se il campo è vuoto, l'interruttore mostra Host at a subpath (e.g. /docs). Inserisci un valore e l'etichetta cambia nel percorso che stai per attivare (Host at /help e così via).
Il campo accetta un solo segmento in minuscolo: solo lettere, cifre e trattini interni, senza trattini iniziali o finali, per un massimo di 63 caratteri. Jamdesk rifiuta i segmenti riservati, tra cui api, jd, percorsi amministrativi comuni come wp-admin e qualsiasi codice di lingua che la documentazione potrebbe usare (fr, es, de e simili). Il sottopercorso non può mai coincidere con un percorso già utilizzato da Jamdesk.
Lascia vuoto il campo per mantenere il valore predefinito /docs.
Rinominare o rimuovere il sottopercorso
Cambiare o svuotare il sottopercorso non interrompe i link già indicizzati o salvati nei segnalibri:
/docsresta sempre disponibile. I percorsi originali/docs/*continuano a rispondere anche dopo il passaggio a un sottopercorso personalizzato come/help. Restano disponibili sul sottodominio[slug].jamdesk.appe tramite qualsiasi proxy che li utilizzi ancora. I link canonici passano subito al nuovo sottopercorso. I motori di ricerca reindicizzano le pagine lì. Puoi aggiornare la configurazione del proxy con i tuoi tempi.- La rinomina di un sottopercorso personalizzato inoltra quello precedente, per una sola rinomina. Rinomina
/helpin/guidee le richieste a/help/*vengono reindirizzate con un codice 308 al percorso corrispondente/guide/*. La cronologia è limitata a un livello. Se rinomini di nuovo/guidein/support,/guide/*reindirizza a/support/*. Jamdesk non tiene più traccia di/help/*(il segmento di due rinomine prima). Questi link portano a una pagina "not found", a volte dopo un reindirizzamento a un percorso combinato insolito. Evita di concatenare le rinomine se vuoi che il reindirizzamento mantenga validi i vecchi link. Aggiorna invece i link esterni al sottopercorso attuale. - Tornando a
/docs, il sottopercorso personalizzato precedente (un livello della cronologia) viene reindirizzato a/docs/*.
/docs non reindirizza al sottopercorso scelto. /docs continua a essere disponibile direttamente, in modo permanente. Il reindirizzamento a un livello si applica solo a un sottopercorso personalizzato che stai abbandonando.
Verifica il proxy visitando https://yoursite.com/docs (o il sottopercorso configurato). Controlla che gli asset e i link vengano caricati.
Devo nascondere il sottodominio jamdesk.app?
No. Il sottodominio [slug].jamdesk.app resta raggiungibile. È l'origine upstream a cui il proxy inoltra le richieste. Non entrerà in competizione con il tuo sito nei risultati di ricerca:
- Dominio registrato: le pagine pubblicate dal sottodominio includono un link canonico che punta alla stessa pagina sul tuo dominio. I motori di ricerca attribuiscono al tuo dominio i segnali di posizionamento.
- Nessun dominio ancora registrato: le pagine del sottodominio in modalità sottopercorso sono contrassegnate con
noindex. Non entrano mai nell'indice.
Per bloccare i contenuti anche sul sottodominio, non solo escluderli dall'indice, attiva la protezione con password. Il sottodominio mostrerà una schermata di sblocco invece della documentazione.