Nginx server - Submap hosting

Nginx is een open-source webserver. Ga voor meer informatie naar de Nginx-documentatie

Een submap/submap instellen

Voorbeeld:

NOTITIE

Vervang het voorbeelddomein door uw eigen door document360 verstrekte domein/aangepast domein.

• Voorbeelddomein weergegeven met behulp van example.document360.io

• Submap/submappad (/docs) weergegeven als example.document360.io/docs

1. Voeg de volgende locatieblokken toe aan je Nginx-configuratiebestand (/etc/nginx/default).

location /docs {
    proxy_pass https://example.document360.io/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name   on;
}

2. Start de Nginx-webserver opnieuw op

3. Als je bijvoorbeeld Nginx op Linux gebruikt, gebruik dan het commando
   $ sudo systemctl restart nginx

NOTITIE

Als u zich op KB Site 2.0 bevindt en uw Knowledge Base als een submap wilt hosten, moet u zowel het pad naar de submap als het pad naar de Site API definiëren.

Instellen op een ander pad dan '/docs'

• U kunt uw kennisbank instellen op andere subdirectorypaden dan /docs.
  Bijvoorbeeld, /help, /support, enz.

• Voeg bij het instellen van andere paden de talen toe die aan elke werkruimte zijn gekoppeld.

• Er moeten nog een paar regels worden toegevoegd om dit te bereiken. Start de server opnieuw op als u klaar bent.

Voorbeeld:

NOTITIE

Vervang het door Document360 geleverde domein en het subdirectory-domein door uw eigen domeinen. Vervang ook de naam van de werkruimte, het pad naar de submap en de taal door uw vereisten.

• Het door Document360 verstrekte domein wordt weergegeven als example.document360.io

• De naam van de werkruimte wordt weergegeven als /v1/

• Pad naar submap weergegeven als /help/

• Taal weergegeven zoals /he voor Hebreeuws.

location /help {
    proxy_pass https://example.document360.io/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name   on;

    sub_filter "v1/docs/" "v1/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}

1. Start de Nginx-webserver opnieuw op

2. Als je bijvoorbeeld Nginx op Linux gebruikt, gebruik dan het commando
   $ sudo systemctl restart nginx

De vervolgkeuzelijst voor werkruimten inschakelen

Als u de vervolgkeuzelijst voor de werkruimte voor uw project wilt inschakelen wanneer u host in een aangepaste submap en een aangepast pad, voegt u de volgende codes toe voor elk van de werkruimten die beschikbaar zijn in uw project.

Voorbeeld:

Laten we aannemen dat er twee werkruimten beschikbaar zijn in uw project, v1 en v2. In dat geval moet je twee codeblokken toevoegen, één voor elke Workspace.

NOTITIE

Vervang het door Document360 geleverde domein en het subdirectory-domein door uw eigen domeinen. Vervang ook de naam van de werkruimte, het pad naar de submap en de taal door uw vereisten.

• Het door Document360 verstrekte domein wordt weergegeven als example.document360.io

• De naam van de werkruimte wordt weergegeven als /v1/,/v2/

• Pad naar submap weergegeven als /help/

• Taal weergegeven zoals /he voor Hebreeuws.

location /v2/help {
    proxy_pass https://example.document360.io/v2/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name   on;

    sub_filter "v2/docs/" "v2/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}
-----------------------------------------------------
location /v1/help {
    proxy_pass https://example.document360.io/v1/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
    proxy_ssl_server_name   on;

    sub_filter "v1/docs/" "v1/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}
-----------------------------------------------------
location = /v2/docs {
    return 301 /v2/help;
}
-----------------------------------------------------
location = /v1/docs {
    return 301 /v1/help;
}

NOTITIE

Als u wilt dat uw lezers kunnen navigeren tussen de verschillende openbare werkruimten van uw project vanuit de vervolgkeuzelijst (met muisklik), voegt u het locatieblok toe voor alle beschikbare werkruimten.

1. Start de Nginx-webserver opnieuw op

2. Als je bijvoorbeeld Nginx op Linux gebruikt, gebruik dan het commando
   $ sudo systemctl restart nginx

Handige links

Hier zijn een paar externe links die u kunnen helpen de Nginx-serverlocatieblokkades in detail te begrijpen:

• NGINX Docs: NGINX en NGINX Plus configureren als een webserver

• DigitalOcean: Inzicht in de algoritmen voor het selecteren van Nginx-servers en locatieblokken

Sitemap genereren

Voorbeeld:

NOTITIE

Vervang het voorbeelddomein door uw eigen door document360 verstrekte domein/aangepast domein.

• Voorbeelddomein weergegeven met behulp van example.document360.io

• Het voorvoegsel van de sitemap blijft hetzelfde, behalve de taalcode (en, fr, de, enz.)  example.document360.io/sitemap.xml.en

location /sitemap.xml.en {
proxy_pass https://example.document360.io/sitemap.xml.en;
proxy_set_header Host example.document360.io;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header "requested-by" "proxy";
proxy_ssl_server_name   on;

Startpagina gehost in een submap

Als u de startpagina van uw project wilt hosten op een aangepast submap-/submappad, voegt u de volgende codes toe voor elk van de beschikbare werkruimten op de startpagina in uw project.

Voorbeeld:

Laten we aannemen dat er twee werkruimten beschikbaar zijn in uw project, V1 en V2. In dat geval moet je twee codeblokken toevoegen, één voor elke Workspace.

NOTITIE

Vervang het door Document360 geleverde domein en het subdirectory-domein door uw eigen domeinen. Vervang ook de naam van de werkruimte, het pad naar de submap en de taal door uw vereisten.

• Het door Document360 verstrekte domein wordt weergegeven als example.document360.io

• De naam van de werkruimte wordt weergegeven als /v1/,/v2/

location =/v1 {
proxy_pass https://example.document360.io/;
proxy_set_header Host example.document360.io;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header "requested-by" "proxy";
proxy_ssl_server_name   on;
}
location =/v2 {
proxy_pass https://example.document360.io/;
proxy_set_header Host example.document360.io;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header "requested-by" "proxy";
proxy_ssl_server_name   on;
}
location /v1/en {
  return 301 /v1;
}
location /v2/en {
  return 301 /v2;
}

PRO TIP

Het gelijkteken kan worden gebruikt als de locatie moet overeenkomen met de exacte aanvraag-URI. Wanneer deze modifier overeenkomt met deze optiek, stopt de zoekopdracht hier. Ga voor meer informatie click here.

Voorbeeld: location =/help {

2. Start de Nginx-webserver opnieuw op

3. Als je bijvoorbeeld Nginx op Linux gebruikt, gebruik dan het commando
   $ sudo systemctl restart nginx

Startpagina van de kennisbanksite

Wat gebeurt er daarna?

Zodra u de webserver met succes hebt geconfigureerd, is uw kennisbanksite live op uw aangepaste submap/submap. De bestaande URL voor uw project zal echter de verzoeken verwerken.

Bijvoorbeeld example.document360.io en example.com/docs (als /docs dit uw mappad is) verwijst naar de Knowledge Base-site.

Dit kan leiden tot dubbele inhoud in zoekmachines (Google, Bing, enz.). Een omleiding van het subdomein van het Document360-project naar uw aangepaste domein is vereist om dit te voorkomen.

NOTITIE

Neem contact met ons op via support@document360.com om de omleiding van example.document360.io naar in te example.com/docsschakelen.

Probleemoplossing

Dit gedeelte biedt stapsgewijze richtlijnen voor het oplossen van veelvoorkomende uitdagingen waarmee u te maken kunt krijgen tijdens het installatieproces van NGINX. Van problemen met het hosten van submappen tot mislukte configuratietests, elke oplossing is ontworpen om u te helpen snel mogelijke wegversperringen te identificeren en op te lossen, zodat een soepele en efficiënte serverconfiguratie wordt gegarandeerd.

Ongeldige locatie-instructie in NGINX oplossen

Fout: nginx: [emerg] "locatie" richtlijn is hier niet toegestaan

Deze fout treedt op wanneer een locatie-instructie buiten de geldige context wordt geplaatst, zoals buiten het serverblok. In NGINX moeten locatieblokkades worden gedefinieerd binnen een serverblok.

Stappen om op te lossen:

1. Zorg ervoor dat het locatieblok correct binnen het serverblok is geplaatst. Raadpleeg het onderstaande voorbeeldblok:

   server {
       listen 80;
       server_name example.com;
       location /docs {
           proxy_pass https://example.document360.io/docs;
           proxy_set_header Host example.document360.io;
       }
   }

2. Om dit probleem te voorkomen, plaatst u locatierichtlijnen niet in de algemene http context of buiten de server context.

3. Als het probleem zich blijft voordoen na het volgen van deze stappen, neem dan contact op met het Document360-ondersteuningsteam voor verdere hulp: Neem contact op met Document360 Support

Probleem met de beschikbaarheid van Certbot-pakketten

Fout: Geen pakket Certbot beschikbaar

Dit probleem treedt vaak op wanneer de EPEL-opslagplaats (vereist voor de installatie van Certbot op RHEL-distributies) niet is ingeschakeld of de pakketbeheerder Certbot niet kan vinden op RHEL-distributies.

Stappen om op te lossen:

1. Schakel de EPEL-repository in met behulp van de onderstaande code:

   sudo yum install epel-release

2. Werk de cache van de opslagplaats bij en probeer Certbot opnieuw te installeren met behulp van de onderstaande code:

   sudo yum install certbot

3. Zorg ervoor dat uw exemplaar internettoegang heeft om de opslagplaatsbestanden op te halen. Als het probleem zich blijft voordoen, controleer dan de configuratiebestanden van de opslagplaats in /etc/yum.repos.d/.

4. Als het probleem zich blijft voordoen na het volgen van deze stappen, neem dan contact op met het Document360-ondersteuningsteam voor verdere hulp: Neem contact op met Document360 Support

Probleem met NGINX-configuratietest

Fout: NGINX-configuratietest mislukt

Dit probleem treedt op wanneer er een syntaxisfout is in het NGINX-configuratiebestand.

Stappen om e:

1. Voer de opdracht voor de configuratietest uit:

   sudo nginx -t

2. Bekijk de foutmelding en het regelnummer zoals in het onderstaande voorbeeld:

   nginx: [emerg] invalid parameter "proxy_pas" in /etc/nginx/sites-enabled/example:22
   nginx: configuration file /etc/nginx/nginx.conf test failed

3. Open het opgegeven bestand /etc/nginx/sites-enabled/example en los het configuratieprobleem op. Bijvoorbeeld:

   # Incorrect
   proxy_pas https://example.com;
   
   # Correct
   proxy_pass https://example.com;

4. Zodra het configuratieprobleem is opgelost, start u NGINX opnieuw op:

   sudo systemctl restart nginx

5. Als het probleem zich blijft voordoen na het volgen van deze stappen, neem dan contact op met het Document360-ondersteuningsteam voor verdere hulp: Neem contact op met Document360 Support

Probleem met SSL-certificaat

Fout: SSL-certificaat werkt niet

Dit probleem kan optreden als gevolg van een onjuiste NGINX SSL-configuratie of wanneer er een probleem is met het geïnstalleerde certificaat. De certificaatgegevens, zoals het domein en de vervaldatum, komen mogelijk niet overeen met de configuratiegegevens.

Stappen om op te lossen:

1. Controleer de certificaatbestanden met behulp van de onderstaande code:

   openssl x509 -in /etc/letsencrypt/live/yourdomain.com/fullchain.pem -text -noout

2. Zorg ervoor dat uw configuratie overeenkomt met de certificaatgegevens, zoals domein en vervaldatum.

3. Zorg ervoor dat de NGINX SSL-configuratie correct is. Raadpleeg de onderstaande code als voorbeeld:

   server {
       listen 443 ssl;
       server_name yourdomain.com;
       
       ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
       ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;
   }

4. Als u klaar bent, start u NGINX opnieuw op met behulp van de onderstaande code:

   sudo systemctl restart nginx

5. Als het probleem zich blijft voordoen na het volgen van deze stappen, neem dan contact op met het Document360-ondersteuningsteam voor verdere hulp: Neem contact op met Document360 Support