User Tools

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
selfhost:nginx [2024/03/06 08:45] – willyselfhost:nginx [2025/03/13 09:29] (current) – external edit 127.0.0.1
Line 1: Line 1:
-====== The Reverse Proxy concept ======+====== F) The Reverse Proxy concept ======
  
 The use of a **reverse proxy** is the key at the foundation of ensuring security, isolation and flexibility in accessing your self-hosted services. The use of a **reverse proxy** is the key at the foundation of ensuring security, isolation and flexibility in accessing your self-hosted services.
  
-A reverse-proxy is a web server that sits in the middle and handles all requests toward your services adding, on top, layers of encyrption (HTTPS/SSL), authentication, load-balancing and security. If your services are properly written (not too many, but the best ones are) they will accept your reverse-proxy authentication directly without even the need to create users for each service, in this case your reverse-proxy will also be your SSO (Single Sign On) solution.+A reverse-proxy is a web server that sits in the middle and handles all requests toward your services adding, on top, layers of encryption (HTTPS/SSL), authentication, load-balancing and security. If your services are properly written (not too many, but the best ones are) they will accept your SSO authentication directly without even the need to create users for each service, in this case your reverse-proxy will also cater for your SSO (Single Sign On) solution . More on this on the dedicated page [[selfhost:sso|Single Sign On]], but keep reading this page first.
  
-The reverse-proxy will also take care of handling HTTP/SSL certificates in one centralized place making it much easier to configure all your services without HTTPS then converting seamlessly all the HTTP traffic to HTTPS. It's much easier to manage one certificate in one place rather than depending on each service capability to handle HTTPS independently.+The reverse-proxy will take care of handling HTTPS/SSL certificates in one centralized place making it much easier to configure all your services without HTTPS then converting seamlessly all the HTTP traffic to HTTPS. It's much easier to manage all the certificates in one place rather than depending on each service capability to handle HTTPS independently.
  
 Also, using a well known, solid and proven web server will alleviate the risk that each service might expose a poorly written, non-scalable or worse, internal web server to end users.  Also, using a well known, solid and proven web server will alleviate the risk that each service might expose a poorly written, non-scalable or worse, internal web server to end users. 
  
-And as a final note, using a reverse-proxy you can organize easily all your services under one single domain. There are limitations, mostly due to poorly written services or peculiar protocols, that might require independent sub-domains, but i will show you how to handle also these cases easily with the reverse-proxy.+And as a final note, using a reverse-proxy you can organize easily all your services either under one single domain or with sub-domains, according to your specific needs.
  
 ===== NGINX ===== ===== NGINX =====
  
 My choice for a web server in this case is [[https://nginx.org|NGINX]] between the many available as Open Source because:  My choice for a web server in this case is [[https://nginx.org|NGINX]] between the many available as Open Source because: 
-  * It's much easier than [[https://www.apache.org|Apache]] to setup as a reverse-proxy, also less resource hungry. +  * It's much easier than [[https://www.apache.org|Apache]] to setup as a reverse-proxy, also less resource hungry, and works with more SSOs than Apache. 
-  * It has more features than [[https://caddyserver.com/|Caddy]] +  * It has more features than [[https://caddyserver.com/|Caddy]]. 
   * It is fully integrated in [[https://letsencrypt.org|Let's Encrypt]] SSL infrastructure / CertBot script   * It is fully integrated in [[https://letsencrypt.org|Let's Encrypt]] SSL infrastructure / CertBot script
  
-In general NGINX is fully featured but still very lightweight and secure HTTP server that shines as reverse-proxy. If you need to add more features, like [[https://www.php.net|PHP]] support or FastCGI, NGINX will support you without the need for an additional service on your server. +In general NGINX is fully featured but still very lightweight and secure HTTP server that shines as reverse-proxy. If you need to add more features, like [[https://www.php.net|PHP]] support or FastCGI, NGINX will support you but with a little bit more effort than Apache.
  
 ===== Base URLs and sub-domains ===== ===== Base URLs and sub-domains =====
  
-There are two different philosophies on how to host services. The one i like best, i think it's simpler and more elegant, is to use one single domain and expose each service in it's own //sub-path// or better call it **Base URL**. The alternative is to allocate one sub-domain for each service.+There are two different philosophies on how to host services: serve as a sub-path of a domain, or use sub-domains. I used to like best the //sub-path// approach, but indeed a good mix of the two ways is preferable.
  
 Let's assume you have your own domain **mydomain.com** and you want to expose a service called //jellyfin// (a well known media-server). You can expose it: Let's assume you have your own domain **mydomain.com** and you want to expose a service called //jellyfin// (a well known media-server). You can expose it:
Line 31: Line 31:
  
 As a **sub-path**:  As a **sub-path**: 
-  * Pros: only one domain needed, no need to create sub-domains (not always possible) +  * Pros: only one domain needed, no need to create sub-domains
-  * Pros: easy to organize services in virtual sub-folders+
   * Pros: the service existence is unknown to anybody not authorized   * Pros: the service existence is unknown to anybody not authorized
-  * Cons: each service must support Base URL setting+  * Cons: each service must support Base URL setting (well, not all do!) 
 +  * Cons: SSO support must be somehow consistent to avoid headaches (well, SSO support is still spotty today!) 
 +  * Cons: security wise, cookies and CORS can bring unintended vulnerabilities between services, because they all share the same subdomain. 
 +  * Cons: all services share the same HTTPS certificate.
  
 As a **sub-domain**: As a **sub-domain**:
   * Pros: any service will work, no need to support Base URL   * Pros: any service will work, no need to support Base URL
-  * Cons: require additional certificates for HTTPS/SSL for each sub-domain  +  * Pros: each service can have it's own HTTPS certificate  
-  * Cons: cannot easily organize together+  * Pros: each service is neatly organized in it's own subdomain 
 +  * Pros: cookies are not shared between services, and CORS protection works
   * Cons: exposed to public knowledge (DNS records are public) that the service exist   * Cons: exposed to public knowledge (DNS records are public) that the service exist
   * Cons: also public knowledge because there are services indexing all existing certificates.   * Cons: also public knowledge because there are services indexing all existing certificates.
  
-__Note:__ you can create //wildcard/ certificates that will match any subdomain, but there are drawbacks to this and it's not a good idea, security wise. You can still mitigate the one certificate per subdomain by adding each subdomain to the same certificate of course, but you will still need to extend your certificate each time you add a subdomain.+__Note:__ you can create //wildcard// certificates that will match any subdomain, but there are drawbacks to this and it's not a good idea, security wise. You can still mitigate the one certificate per subdomain by adding each subdomain to the same certificate of course, but you will still need to extend your certificate each time you add a subdomain: this is my approach.
  
-I prefer the sub-path whenever possible, but in some cases you will be forced to use sub-domains. And what if you cannot spin your sub-domains? Well, forget those services that require a subdomain.+To make a story short, i go with subdomains for well separated services, while going with sub-paths when sharing stuff that kind belongs together. Also, a deciding factor is whether the selected services do support SSO properly or not.
  
-Then using sub-paths, the use of a reverse-proxy like NGINX allows you a little bit of flexibility because you can, to an extend, perform rewrite operations on URL's and also on the response to the browser, but this all come to a cost in processing power and, moreover, it's not always feasible. In general for sub-paths to work properly it has to be supported by the service. 
  
 +===== Reverse Proxy propagation =====
  
-===== Authentication =====+The reverse proxy is installed on the local server, i assume your local server is reachable from remote (see [[networking:external_access|Remote Access to your Home Server]]). 
  
-Having a strong layer of authentication is mandatory for self-hosted services that are exposed to the internet. We talking about authentication it's important to remember that is has a double meaning: to recognize a user rather than another use, and to restrict access to your service based on who the user is.+The reverse proxy will need to be accessible to both the internal users and the external users. You could setup two different proxies, but i prefer to have only one listening to both worlds. I will assume that there might be differences between internal and external users in terms of authentication or service availability. The underlying idea is that you will have your reverse proxy listening to different ports: one for internal access and one for external access.
  
-A few assumptions: self-hosting for home access, which means a limited and trusted list of users which doesn't change often in time. Security is important, but ease of use is also important. Simplicity of user management is also important. +The setup i am describing uses three different ports:
- +
-There are a few key points that i want to stress on authentication: +
-  * 2FA (Two Factor Authentication) will not be considered +
-  * You want to create users only once, as much as possible. +
-  * Only selected services will need to differentiate between users +
-  * Most services will not need to know who is accessing them +
-  * From outside, **all** services must require authentication +
-  * From inside, authentication is required only where a specific user makes a difference +
-  * Avoid double authentication when possible +
- +
-For example, a //media server// will need to know who is connecting to show your preferred shows and your "resume from here..." movies. The printer control page instead should be accessible by anyone inside home. +
- +
-Authentication will be required when connecting from //outside//, always, while will be needed only for selected services from //inside//. +
- +
-The most simple and effective approach is to enable the PAM Authentication plugin of NGINX and connect your reverse-proxy authentication to your server user management. So that by adding a new user to your server, that will be automagically added to your services, or at least the ones that can link to reverse-proxy authentication.  +
- +
-You have the following combinations: +
-  * Services that do not require to differentiate the user +
-  * Services that needs to know who is connecting, and **can** get this info from the reverse-proxy +
-  * Services that needs to know who is connecting, and **cannot** get this info from the reverse-proxy +
- +
-You will be able to play with the PAM authentication module of NGINX on a per-service base to achieve this. +
- +
-The general rule is as follow: +
-^ Service                                     ^ From inside       ^ From outside     ^ +
-| do not require authentication               | auth not required | use PAM auth     | +
-| Require auth, can use reverse-proxy auth    | use PAM auth      | use PAM auth     | +
-| Require auth, cannot use reverse-proxy auth | use service auth  | use service auth | +
- +
-Using PAM Auth on services that cannot understand reverse-proxy auth is great way to increase security as others will not even be able to reach your service, but will require the users to perform the authentication twice and might cause some mobile apps to fail. +
- +
-Please note that for services that cannot use reverse-proxy auth you will need to create users. +
- +
-There is a more complex solution which is using something like [[https://www.authelia.com|Authelia]] or [[https://goauthentik.io|Authentik]] which support 2FA and OAuth, but again whether your services will support it or not is hit-and-miss, and for my needs is simply too much. +
- +
-===== Reverse Proxy propagation to external world ===== +
- +
-The reverse proxy is installed on the local server, you should have already guessed that remote access is performed using the SSH tunnelling described in the [[selfhost:ssh_tunnel|specific page]]. The underlying idea is that you will have your reverse proxy listening to different ports, and these ports will be forwarded to your external server using the SSH tunnels. Differentiating the ports is required to be able to apply PAM authentication depending on where your user connects from. +
- +
-The setup i am proposing uses three different ports:+
   * Port 80: both to local and remote, will just be a redirect to HTTPS   * Port 80: both to local and remote, will just be a redirect to HTTPS
-  * Port 443: standard HTTPS for **internal** access, no PAM authentication +  * Port 443: standard HTTPS for **internal** access 
-  * Port 8443: HTTPS with PAM authentication for **external** access +  * Port 8443: HTTPS for **external** access 
  
-**Note:** for Let's Encrypt CertBot to work properly you need to redirect port 80 and 443 from your external server to your internal server. CertBot will shutdown your NGINX and spin a custom NGINX server that you cannot tweak so it's critical that your SSH tunnels are properly forwarding ports 80 and 443 from the external server to the internal one, or it will not work.+**Note:** for Let's Encrypt CertBot to work properly you **need** to redirect **both** port 80 and 443 from your external server to your internal server. CertBot will shutdown your NGINX and spin a custom NGINX server that you cannot tweak so it's critical that your SSH tunnels are properly forwarding ports 80 and 443 from the external server to the internal one, or it will not work.
  
  
 ===== Installing NGINX ===== ===== Installing NGINX =====
  
-NGINX installation on the home server is pretty straightforward, but you need to enable one specific authentication module, the //pam// authentication module, because that will link NGINX authentication to your home server users directly, without the need to create more users and passwords. If you prefer to use a different authentication, like //basic_auth//, i leave this out to you.+NGINX installation on the home server is pretty straightforward, but you need to enable some specific modules: 
 +  * //auth_request//: needed for SSO like authelia 
 +  * //auth_pam//: needed for PAM SSO 
 +  * //sub// is used to allow substitutions inside the pages proxied, to fix web applications that don't play well with reverse-proxies 
 +  * //gunzip// is used to unzip the requests and let the //sub// module works also on compressed requests 
 +  * //realip// is needed by SSO like authelia 
 + 
 +While NGINX support WebDAV, i strongly suggest you __dont__ enable it as you will not be using it. NGINX WebDAV support is lacking and not really recomended.
  
 So create the file **/etc/portage/package.use/nginx** with the following lines: So create the file **/etc/portage/package.use/nginx** with the following lines:
 <file - nginx> <file - nginx>
 app-misc/mime-types nginx app-misc/mime-types nginx
-www-servers/nginx NGINX_MODULES_HTTP: auth_pam gunzip sub+www-servers/nginx NGINX_MODULES_HTTP: auth_request auth_pam dav dav_ext gunzip sub realip xslt 
 </file> </file>
  
-The **gunzip** and **sub** modules might be useful to support URL rewrite and such. +Note: you might want to tweak the second line to your needs, see the [[https://wiki.gentoo.org/wiki/Nginx|flags for nginx]] and adapt. 
- +
-Note: you might want to tweak the second line to your needs, see the [[https://wiki.gentoo.org/wiki/Nginx|flags for nginx]] and adapt. +
- +
-A brief explanation of the above USE flags: +
-  * //auth_pam// is used to enable PAM based authentication +
-  * //sub// is used to allow substitutions inside the pages proxied, to fix web applications that don't play well with reverse-proxies +
-  * //gunzip// is used to unzip the requests and let the //sub// module works also on compressed requests+
  
 Now install nginx: Now install nginx:
 <code bash> <code bash>
- > emerge -v nginx+emerge -v nginx
 </code> </code>
  
-===== NGINX pam_auth ===== +You can start it after you have configured it.
- +
-I think it's nice that with NGINX you can authenticate your users directly with your home server users. This means you don't need to add a second set of users, and that the users will only need one password, and no sync is required between HTTP users and server users. This is achieved using the **pam_auth** module on Linux. You have already built nginx with pam_auth support, but you need to configure it. +
- +
-Create the file **/etc/pam.d/nginx** with these lines: +
-<file - nginx> +
-auth required pam_unix.so +
-account required pam_unix.so +
-</file>+
  
  
Line 142: Line 97:
  
 Assumptions: Assumptions:
-  * Your domain is **mydomain.com** +  * Your domain is **mydomain.com**, and it has a static landing page under __/var/www/html/index.html__ 
-  * Your service X is reachable under **https://mydomain.com/serviceX** +  * Your service X is reachable under **https://mydomain.com/serviceX** (subpath) 
-  * Your service Y is reachable under **https://y.mydomain.com** +  * Your service Y is reachable under **https://y.mydomain.com** (subdomain)
-  * Your domain name is replicated with local addresses inside your home (see [[selfhost:dnsmasq|here]])+
   * All HTTP traffic is redirected to HTTPS   * All HTTP traffic is redirected to HTTPS
 +  * You have a single Let's Encrypt SSL certificate which covers all the subdomains of your domain (either a wildcard or a comulative cert it's up to you)
 +  * You might have more than one main domain
  
-You will need the following files:+The top-level **mydomain.com** will have it's own folder, then you will create a set of sub-folders stemming from the main domain, one folder for each sub-domains, and inside each folder one configuration file for each sub-path served on that sub-domain. 
 + 
 +So you will need the following files:
   * **/etc/nginx/nginx.conf**: main config file, entry point.   * **/etc/nginx/nginx.conf**: main config file, entry point.
-  * **/etc/nginx/com.mydomain/**: folder to store all configs related to //mydomain.com// 
   * **/etc/nginx/com.mydomain/certbot.conf**: SSL certificates configuration for //mydomain.com//   * **/etc/nginx/com.mydomain/certbot.conf**: SSL certificates configuration for //mydomain.com//
   * **/etc/nginx/com.mydomain/mydomain.conf**: global config for //mydomain.com//   * **/etc/nginx/com.mydomain/mydomain.conf**: global config for //mydomain.com//
-  * **/etc/nginx/com.mydomain/y/**: folder to store all configs related to //y.mydomain.com// 
-  * **/etc/nginx/com.mydomain/y/y.conf**: config for //serviceY// on //y.mydomain.com// 
   * **/etc/nginx/com.mydomain/serviceX.conf**: config for //serviceX// on //mydomain.com//   * **/etc/nginx/com.mydomain/serviceX.conf**: config for //serviceX// on //mydomain.com//
 +  * **/etc/nginx/com.mydomain/y/y.conf**: config for //serviceY// on //y.mydomain.com//
 +  * plus any other SSO specific config files.
  
-The **certbot.conf** file will be created later on.+The **certbot.conf** file will be created later on, the specific SSO config files are described in the [[selfhost:sso|Authentication]] page.
  
-Note that when multiple services are hosted on the same domain (like serviceX on mydomain.com) for clarity i prefer to split them into separated config files. 
  
-So, here is the content for the **/etc/nginx/nginx.conf**:+==== Top-level configuration  ==== 
 + 
 +So, here is the content for the main **/etc/nginx/nginx.conf**:
 <file - nginx.conf> <file - nginx.conf>
 user nginx nginx; user nginx nginx;
Line 194: Line 152:
         }         }
  
-        # Add domains here (only the main config file for each subdomain!)+        # Using Authelia SSO can lead to longer headers, better increase buffers 
 +        proxy_headers_hash_max_size 512; 
 +        proxy_headers_hash_bucket_size 128; 
 + 
 +        # Add domains here (only the main config file for each domain!)
         include com.mydomain/mydomain.conf;         include com.mydomain/mydomain.conf;
-        include com.mydomain/y/y.conf;+         
 +        # This is for SSL and needs to be included only once for all the domains 
 +        include /etc/letsencrypt/options-ssl-nginx.conf;
 } }
 </file> </file>
  
-I will show you come raw example for the **mydomain.conf** and **y.conf**, detailed examples for each service will be described within each service description page.+This will set your defaults for every service and site served by this reverse proxy, then will load the //mydomain.com// specific configuration file.
  
-The following **mydomain.conf** is required when you need to differentiate on PAM authentication between internal and external access. You will need to create two different //server// blocks with slightly different configuration (please do not use the 'if' statement here as duplicating the server block is the preferred way by NGINX):+ 
 +==== mydomain.com configuration  ==== 
 + 
 +Now, for the specific **mydomain.com**, you need the following config file under **/etc/nginx/com.mydomain/mydomain.conf**:
 <file - mydomain.conf> <file - mydomain.conf>
-# Manage tunnels request from external server + 
-# HTTPS listen on a custom port (8443) because this is authenticated+access_log /var/log/nginx/mydomain.com_access_log main; 
 +error_log /var/log/nginx/mydomain.com_error_log info; 
 + 
 +# simple catch-all server for the domain
 server { server {
-        server_name 10.0.0.1 mydomain.com;+       # You might want to specify also the internal  
 +        server_name mydomain.com; 
 +        # Port for users from outside
         listen 8443 ssl;         listen 8443 ssl;
-        access_log /var/log/nginx/mydomain.com_access_log main; +        # Port for users from inside 
-        error_log /var/log/nginx/mydomain.com_error_log info; +        listen 443 ssl; 
-        root /data/web/htdocs; +        http2 on; 
-        auth_pam "Home"; + 
-        auth_pam_service_name "nginx"; +        # unauthenticated static landing page (maybe a "get off my lawn" GIF...) 
-        include "com.mydomain/serviceX.conf"; +        location / { 
-        include com.mydomain/certbot.conf;+               root /var/www/html; 
 +        } 
 + 
 +       # include all sub-paths for mydomain.com: 
 +       include serviceX.conf; 
 + 
 +       # include HTTPS certs stuff: 
 +       include org.gardiol/certbot.conf;
 } }
  
-# Manage direct request inside home network +# include all sub-domains entry points: 
-# It's identical to the remote one, but it has no authentication +include com.mydomain/y/y.conf; 
-# HTTPS on port 443 for direct local connections+</file> 
 + 
 +This will create the basic setup for your base domain name. I have assumed you want a static landing page, but you might put a //redirect// to service Y or service X... Or add a dashboard, of course protected by your SSO... 
 + 
 + 
 +==== sub-domains configuration  ==== 
 + 
 +It should be clear now that each sub-domain will have it's own sub-folder and contain at least one (or more) configuration files inside for each sub-path, like the one for serviceY.  
 + 
 +I will assume that //serviceY// perform it's own authentication and cannot use SSO: 
 +<file - y.conf>
 server { server {
-        server_name 10.0.0.1 mydomain.com; +       server_name y.mydomain.com; 
-        listen 8443 ssl; +       listen 8443 ssl; # external access 
-        access_log /var/log/nginx/mydomain.com_access_log main; +       listen 443 ssl; # internal access 
-        error_log /var/log/nginx/mydomain.com_error_log info; +       access_log /var/log/nginx/y.mydomain.com_access_log main; 
-        root /data/web/htdocs; +       error_log /var/log/nginx/y.mydomain.com_error_log info; 
-        include "com.mydomain/serviceX.conf"; +       location / { 
-        include com.mydomain/certbot.conf;+               #Generic proxy pass to proxied service 
 +               proxy_pass http://127.0.0.1:8000; 
 +       } 
 +       # include HTTPS certs stuff: 
 +       include org.gardiol/certbot.conf;
 } }
 </file> </file>
  
-In this case i assume you have more than one service, so i split the service config in separated files (serviceX.conf), imagine to have one for each service.+I suggest you split all sub-paths for each sub-domain in a separate config file and //include// them inside the //server// block, like i did above for //mydomain.com//.
  
-Instead, i will assume that //serviceY// perform it's own authentication and cannot use reverse-proxy auth, so PAM auth is not needed: + 
-<file - y.conf>+==== Differentiate between Internal or External access for services ==== 
 + 
 +In my setup i have some differences when a service is accessed from //within// the home network, or from //outside// the home network. 
 + 
 +The key point is that //external// access comes trough port 8443, while //internal// aces comes trough port 443. This allows you to differentiate your setup with __server__ blocks. 
 + 
 +So, for example, a service _only_ available inside the home network will have something like: 
 +<code> 
 +server { 
 +        server_name internal_only.mydomain.com; 
 +        listen 443 ssl; # internal access 
 +        http2 on; 
 +        access_log /var/log/nginx/internal_only.mydomain.com_access_log main; 
 +        error_log /var/log/nginx/inernal_only.mydomain.com_error_log info; 
 +        location / { 
 +                #Generic proxy pass to proxied service 
 +                proxy_pass http://127.0.0.1:8000; 
 +        } 
 +       # include HTTPS certs stuff: 
 +       include org.gardiol/certbot.conf; 
 +} 
 +</code> 
 + 
 +While a service that can be accessed both from internal and external: 
 +<code>
 server { server {
-        server_name y.mydomain.com;+        server_name serviceZ.mydomain.com;
         listen 8443 ssl; # external access         listen 8443 ssl; # external access
         listen 443 ssl; # internal access         listen 443 ssl; # internal access
-        # Enable these two lines to use PAM auth +        http2 on; 
-        #auth_pam "Home"; +        access_log /var/log/nginx/serviceZ.mydomain.com_access_log main; 
-        #auth_pam_service_name "nginx"; +        error_log /var/log/nginx/serviceZ.mydomain.com_error_log info;
-        access_log /var/log/nginx/y.mydomain.com_access_log main; +
-        error_log /var/log/nginx/y.mydomain.com_error_log info;+
         location / {         location / {
                 #Generic proxy pass to proxied service                 #Generic proxy pass to proxied service
                 proxy_pass http://127.0.0.1:8000;                 proxy_pass http://127.0.0.1:8000;
         }         }
-        include com.mydomain/certbot.conf;+       # include HTTPS certs stuff: 
 +       include org.gardiol/certbot.conf;
 } }
-</file>+</code> 
 + 
 +A service where you want to differentiate between internal and external, for example adding SSO authentication only for external access: 
 +<code> 
 +server { 
 +        server_name serviceZ.mydomain.com; 
 +        listen 443 ssl; # internal access 
 +        http2 on; 
 +        access_log /var/log/nginx/serviceZ.mydomain.com_access_log main; 
 +        error_log /var/log/nginx/serviceZ.mydomain.com_error_log info; 
 +        location / { 
 +                #Generic proxy pass to proxied service 
 +                proxy_pass http://127.0.0.1:8000; 
 +        } 
 +       # include HTTPS certs stuff: 
 +       include org.gardiol/certbot.conf; 
 +} 
 +server { 
 +        server_name serviceZ.mydomain.com; 
 +        listen 8443 ssl; # external access 
 +        http2 on; 
 +        [[[ put here your SSO lines ]]] 
 +        access_log /var/log/nginx/serviceZ.mydomain.com_access_log main; 
 +        error_log /var/log/nginx/serviceZ.mydomain.com_error_log info; 
 +        location / { 
 +                #Generic proxy pass to proxied service 
 +                proxy_pass http://127.0.0.1:8000; 
 +        } 
 +       # include HTTPS certs stuff: 
 +       include org.gardiol/certbot.conf; 
 +} 
 +</code> 
 + 
 +In this case, you can even optimize more by moving the **location** lines, which are identical, inside another file that you __include__ twice. Better to avoid redundancy!
  
-Of course, if instead your service do require authentication but can use reverse-proxy auth, uncomment the two **auth_pam** lines and there you go.+Of course, refer to the [[selfhost:sso|SSI]] page for more details on SSO.
  
-Again, detailed configurations will be provided for each service. 
  
 ===== Generate SSL certificates for HTTPS ===== ===== Generate SSL certificates for HTTPS =====
  
-Nowadays HTTPS is a must for many reasons, including privacy and security. I assume this is a mandatory requirement.+Nowadays HTTPS is a must for many reasons, including privacy and security. I assume this is a mandatory requirement. A lot of services will not even work without HTTPS.
  
 Enabling HTTPS requires the generation of valid SSL certificates for your domain(s). You can do that with self-signed certificates but that will still flag as insecure on your browser and some client apps might even not work properly. A better solution is to use the [[https://letsencrypt.org|Let's Encrypt]] certification authority which is an open-source, public and free Certificate Authority that let's you generate and manage your certificates. Enabling HTTPS requires the generation of valid SSL certificates for your domain(s). You can do that with self-signed certificates but that will still flag as insecure on your browser and some client apps might even not work properly. A better solution is to use the [[https://letsencrypt.org|Let's Encrypt]] certification authority which is an open-source, public and free Certificate Authority that let's you generate and manage your certificates.
Line 292: Line 340:
  
 Now, you **must** generate certificates that chains toghether all the subdomains you use. This means that if you add, later on, another sub-domain to host a new service you will **need to** re-run the above //certbot// command adding //-d newsubdomain.mydomain.com//. And do not forget all the older ones! Luckly, domain names can be chained to on single certificate, so you do not have to edit your NGINX config ever again for CertBot to work. Now, you **must** generate certificates that chains toghether all the subdomains you use. This means that if you add, later on, another sub-domain to host a new service you will **need to** re-run the above //certbot// command adding //-d newsubdomain.mydomain.com//. And do not forget all the older ones! Luckly, domain names can be chained to on single certificate, so you do not have to edit your NGINX config ever again for CertBot to work.
- 
-This is also why using sub-paths is simpler: you do not have to extend your certificate for a new service. 
  
 Put this content into your **/etc/nginx/com.mydomain/certbot.conf**: Put this content into your **/etc/nginx/com.mydomain/certbot.conf**:
Line 307: Line 353:
 Let's Encrypt certificates last 90 days, then they need to be renewed. This is automated by CertBot but you need to call it periodically. You can use crontab for this. Edit root crontab: Let's Encrypt certificates last 90 days, then they need to be renewed. This is automated by CertBot but you need to call it periodically. You can use crontab for this. Edit root crontab:
 <code bash> <code bash>
- > crontab -e+crontab -e
 </code> </code>
  
Line 321: Line 367:
  
 <code bash> <code bash>
- > rc-update add nginx default +rc-update add nginx default 
- > /etc/init.d/nginx start+/etc/init.d/nginx start
 </code> </code>
 +
 +
 +
 +==== Quick and dirty script for new subdomains ====
 +
 +When you need to **add** a new subbomain to your certificate, you can copy (and adapt) the following script i use:
 +<file - certbot_script.sh>
 +#!/bin/bash
 +
 +DOMAINS="mydomain.con y.mydomain.com other.mydomain.com"
 +
 +domains=
 +for i in ${DOMAINS}
 +do
 +        domains="${domains} -d ${i}"
 +done
 +
 +certbot certonly --expand --nginx ${domains}
 +</file>
 +
 +So __FIRST__ you **update** the script adding the new domain at the end of the DOMAINS line, then you run the script and restart your NGINX.
 +
  
 ===== Enable CGI support with NGINX ===== ===== Enable CGI support with NGINX =====
Line 329: Line 397:
 To be able to run system scripts and, in general, [[https://en.wikipedia.org/wiki/CGI|CGIs]] on NGINX you need to do some additional configuration. NGINX is not capable of running CGI scripts at all. It has only support for [[https://en.wikipedia.org/wiki/FastCGI|FastCGI]] protocol, which is **quite different** and **not directly compatible** with standard CGI. To be able to run system scripts and, in general, [[https://en.wikipedia.org/wiki/CGI|CGIs]] on NGINX you need to do some additional configuration. NGINX is not capable of running CGI scripts at all. It has only support for [[https://en.wikipedia.org/wiki/FastCGI|FastCGI]] protocol, which is **quite different** and **not directly compatible** with standard CGI.
  
-For using CGI directly with NGGINX (another option coule be run Apache or another web server) you can install and setup [[https://www.nginx.com/resources/wiki/start/topics/examples/fcgiwrap/|fcgiwrap]] and it's companion spawn package:+For using CGI directly with NGINX (another option could be to run Apache or another web server in addition, but why?) you can install and setup [[https://www.nginx.com/resources/wiki/start/topics/examples/fcgiwrap/|fcgiwrap]] and it's companion spawn package:
 <code bash> <code bash>
 emerge www-misc/fcgiwrap www-servers/spawn-fcgi emerge www-misc/fcgiwrap www-servers/spawn-fcgi
Line 342: Line 410:
 The contents of the config file sohuld be: The contents of the config file sohuld be:
 <file - spawn-fcgi.fcgiwrap> <file - spawn-fcgi.fcgiwrap>
-FCGI_SOCKET=/var/run/fcgiwrap.sock+# The "-1" is added on my system, check on your YMMV! 
 +FCGI_SOCKET=/var/run/fcgiwrap.sock-1
 FCGI_PORT= FCGI_PORT=
-FCGI_PROGRAM=/usr/sbin/fcgiwrap+# The -f send stderr to nginx log 
 +FCGI_PROGRAM="/usr/sbin/fcgiwrap -f"
 FCGI_USER=nginx FCGI_USER=nginx
 FCGI_GROUP=nginx FCGI_GROUP=nginx
Line 364: Line 434:
             fastcgi_param DOCUMENT_ROOT /path/to/gci/executable/folder/;             fastcgi_param DOCUMENT_ROOT /path/to/gci/executable/folder/;
             fastcgi_param SCRIPT_NAME   my_cgi;             fastcgi_param SCRIPT_NAME   my_cgi;
-            fastcgi_pass unix:/var/run/fastcgi.sock;+            fastcgi_pass unix:/var/run/fcgiwrap.sock;
        }        }
 </file> </file>
 +
  
 ===== In short: add & enable a service ===== ===== In short: add & enable a service =====

This website uses technical cookies only. No information is shared with anybody or used in any way but provide the website in your browser.

More information