Nginx - Revision history

imported>Sjwhitak: /* Initial setup */

2022-04-07T18:02:03Z

Initial setup

← Older revision		Revision as of 18:02, 7 April 2022
Line 12:		Line 12:
	</syntaxhighlight>		</syntaxhighlight>

	If that's all you want, don't use nginx; it'd be easier to write a [https://funprojects.blog/2021/04/11/a-web-server-in-1-line-of-bash/ single-lined Bash script] to run a single page.		{{Note\|If that's all you want, don't use nginx; it'd be easier to write a [https://funprojects.blog/2021/04/11/a-web-server-in-1-line-of-bash/ single-lined Bash script] to run a single page.}}

	In <code>/etc/nginx/nginx.conf</code>, <code>/etc/nginx/conf.d/.conf</code> and <code>/etc/nginx/sites-enabled/</code> are included. Therefore, if you have a complicated set up, you can split up your configuration among multiple files.		In <code>/etc/nginx/nginx.conf</code>, <code>/etc/nginx/conf.d/.conf</code> and <code>/etc/nginx/sites-enabled/</code> are included. Therefore, if you have a complicated set up, you can split up your configuration among multiple files.

			To test your configuration,
⚫	~~To test your configuration, <code>nginx -t</code>~~ will tell you what syntax is wrong if there happens to be any. For instance, some directives can't be certain areas.
			{{RootCmd\|nginx -t}}
		⚫	This will tell you what syntax is wrong if there happens to be any. For instance, some directives can't be certain areas.

	== A single domain ==		== A single domain ==

imported>Sjwhitak: /* TLS */

2022-04-07T17:55:51Z

TLS

← Older revision		Revision as of 17:55, 7 April 2022
Line 236:		Line 236:

	Instead, we can use a free service, [https://letsencrypt.org/ Let's Encrypt], [https://dehydrated.io/ Dehydrated], or [https://zerossl.com/ ZeroSSL]. Let's Encrypt is the most common, and is a straightforward set up.		Instead, we can use a free service, [https://letsencrypt.org/ Let's Encrypt], [https://dehydrated.io/ Dehydrated], or [https://zerossl.com/ ZeroSSL]. Let's Encrypt is the most common, and is a straightforward set up.
		⚫	{{RootCmd\|apt install certbot python3-certbot-nginx}}
	<syntaxhighlight lang="bash">
⚫	apt install certbot python3-certbot-nginx
	</syntaxhighlight>
	Once certbot is installed, ensure your domain is pointed to the correct nginx server, then run:		Once certbot is installed, ensure your domain is pointed to the correct nginx server, then run:
		⚫	{{RootCmd\|certbot --nginx -d example.com -d ...}}
	<syntaxhighlight lang="bash">
⚫	certbot --nginx -d example.com -d ...
	</syntaxhighlight>
	Where you can keep chaining <code>-d <domain></code> for each domain you have. <code>python3-certbot-nginx</code> will find the right nginx configuration to call, and <code>certbot</code> will make sure you've got rights to that domain. You can't just run certbot on google.com, you need to own the domain and the IP that domain is connected to. At this point, <code>python3-certbot-nginx</code> should have edited your nginx configuration to have certbot's certificate auto-configured. If you force https, you'll see:		Where you can keep chaining <code>-d <domain></code> for each domain you have. <code>python3-certbot-nginx</code> will find the right nginx configuration to call, and <code>certbot</code> will make sure you've got rights to that domain. You can't just run certbot on google.com, you need to own the domain and the IP that domain is connected to. At this point, <code>python3-certbot-nginx</code> should have edited your nginx configuration to have certbot's certificate auto-configured. If you force https, you'll see:
	<syntaxhighlight lang="nginx" line>		<syntaxhighlight lang="nginx" line>
Line 292:		Line 288:
	[https://letsencrypt.org/ Let's Encrypt] is simple. Just run <code>certbot renew</code> and it'll renew your certificate.		[https://letsencrypt.org/ Let's Encrypt] is simple. Just run <code>certbot renew</code> and it'll renew your certificate.

	[https://letsencrypt.org/ Let's Encrypt]'s certificates are valid for 3 months, so you can update this every 3 months when it expires. Or, have a cronjob do it for you! Type ~~<code>crontab -e</code> and then add:~~		[https://letsencrypt.org/ Let's Encrypt]'s certificates are valid for 3 months, so you can update this every 3 months when it expires. Or, have a cronjob do it for you! Type
			{{RootCmd\|crontab -e}}
			and then add:

	0 12 * * * /usr/bin/certbot renew --quiet		0 12 * * * /usr/bin/certbot renew --quiet

imported>Sjwhitak: Pretty templates

2022-04-07T17:54:45Z

Pretty templates

← Older revision		Revision as of 17:54, 7 April 2022
Line 342:		Line 342:

	At this point, we have nginx pointing to port <code>7777</code> for our <code>fastcgi</code> server to run the php files. We need to configure <code>fpm</code> to do this:		At this point, we have nginx pointing to port <code>7777</code> for our <code>fastcgi</code> server to run the php files. We need to configure <code>fpm</code> to do this:
		⚫	{{RootCmd\|vim /etc/php/7.4/fpm/pool.d/www.conf}}
	<syntaxhighlight lang="bash">
⚫	vim /etc/php/7.4/fpm/pool.d/www.conf
	</syntaxhighlight>
	and write		and write
	<syntaxhighlight lang="text" line start="36">		<syntaxhighlight lang="text" line start="36">
Line 351:		Line 349:

	Update everything with systemd,		Update everything with systemd,
		⚫	{{RootCmd\|systemctl restart nginx}}
	<syntaxhighlight lang="bash">
	systemctl restart ~~nginx~~		{{RootCmd\|systemctl restart php7.4-fpm}}

⚫	systemctl restart ~~php7.4-fpm~~
	</syntaxhighlight>
	and the two sites should work.		and the two sites should work.

imported>Sjwhitak: Remove editing thing

2022-03-20T17:54:09Z

Remove editing thing

← Older revision		Revision as of 17:54, 20 March 2022
Line 65:		Line 65:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	Please note that you'll need [https://shell.lug.mtu.edu/wiki/index.php?title=Nginx~~&action=submit~~#fastcgi php add-ons] and more configurations to have [https://www.phpbb.com/ phpbb] and [https://www.mediawiki.org/wiki/MediaWiki mediawiki] to run, but this is just a basic example.		Please note that you'll need [https://shell.lug.mtu.edu/wiki/index.php?title=Nginx#fastcgi php add-ons] and more configurations to have [https://www.phpbb.com/ phpbb] and [https://www.mediawiki.org/wiki/MediaWiki mediawiki] to run, but this is just a basic example.

	=== Subservers ===		=== Subservers ===

imported>Sjwhitak: Add more options

2022-03-20T17:14:20Z

Add more options

@@ Line 66: / Line 66: @@
 </syntaxhighlight>
 Please note that you'll need [https://shell.lug.mtu.edu/wiki/index.php?title=Nginx&action=submit#fastcgi php add-ons] and more configurations to have [https://www.phpbb.com/ phpbb] and [https://www.mediawiki.org/wiki/MediaWiki mediawiki] to run, but this is just a basic example.
 If you want to protect your server from people access your IP (typically if they're crawling via IPs, they're probably not up to something good), you can up a configuration:

imported>Sjwhitak: Mediawiki, not markdown

2022-03-14T20:49:10Z

Mediawiki, not markdown

← Older revision		Revision as of 20:49, 14 March 2022
Line 275:		Line 275:
	echo "Here's all my blog files" > index.html		echo "Here's all my blog files" > index.html
	</syntaxhighlight>		</syntaxhighlight>
	Configure `nginx` to point at these files, edit `/etc/nginx/sites-enabled/sites.conf`:		Configure <code>nginx</code> to point at these files, edit <code>/etc/nginx/sites-enabled/sites.conf</code>:
	<syntaxhighlight lang="nginx">		<syntaxhighlight lang="nginx">
	server {		server {
Line 301:		Line 301:
	Please note that specifically with mediawiki, there are more configurations typically added, like denying access to deleted images, cached files, etc. To do that, paste your URL to: [https://shorturls.redwerks.org/ shortURLs] and step through their given configuration. Finally, mediawiki uses [[mysql]] to run a database, though this is explained when you follow the [https://www.mediawiki.org/wiki/Manual:Installation_guide installation guide].		Please note that specifically with mediawiki, there are more configurations typically added, like denying access to deleted images, cached files, etc. To do that, paste your URL to: [https://shorturls.redwerks.org/ shortURLs] and step through their given configuration. Finally, mediawiki uses [[mysql]] to run a database, though this is explained when you follow the [https://www.mediawiki.org/wiki/Manual:Installation_guide installation guide].

	At this point, we have nginx pointing to port `7777` for our `fastcgi` server to run the php files. We need to configure `fpm` to do this:		At this point, we have nginx pointing to port <code>7777</code> for our <code>fastcgi</code> server to run the php files. We need to configure <code>fpm</code> to do this:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	vim /etc/php/7.4/fpm/pool.d/www.conf		vim /etc/php/7.4/fpm/pool.d/www.conf

imported>Sjwhitak: Added example.

2022-03-14T20:47:57Z

Added example.

← Older revision		Revision as of 20:47, 14 March 2022
Line 259:		Line 259:

	You want to run a blog that hosts static pages and a wiki that runs [https://www.mediawiki.org/wiki/MediaWiki mediawiki].		You want to run a blog that hosts static pages and a wiki that runs [https://www.mediawiki.org/wiki/MediaWiki mediawiki].

			Here's the steps you'd take with a fresh system (everything run as root):

			<syntaxhighlight lang="bash">
			apt install nginx php7.4 php7.4-fpm git
			</syntaxhighlight>

			Make sure you get the php version that's most recent or the one that's used by whatever software you're trying to use. This example uses version 7.4.

			Then, make your folders and grab your content:
			<syntaxhighlight lang="bash" line>
			mkdir /var/www/wiki; cd /var/www/wiki
			git clone https://github.com/wikimedia/mediawiki .
			mkdir /var/www/blog; cd /var/www/blog
			echo "Here's all my blog files" > index.html
			</syntaxhighlight>
			Configure `nginx` to point at these files, edit `/etc/nginx/sites-enabled/sites.conf`:
			<syntaxhighlight lang="nginx">
			server {
			root /var/www/blog;
			index index.html;
			server_name blog.example.com;
			listen 80;
			listen [::]:80;
			}
			server {
			root /var/www/mediawiki;
			index index.php;
			server_name wiki.example.com;
			listen 80;
			listen [::]:80;
			location ~ \.php {
			try_files $uri = 404;
			fastcgi_pass 127.0.0.1:7777;
			fastcgi_index index.php;
			include fastcgi_params;
			include fastcgi.conf;
			}
			}
			</syntaxhighlight>
			Please note that specifically with mediawiki, there are more configurations typically added, like denying access to deleted images, cached files, etc. To do that, paste your URL to: [https://shorturls.redwerks.org/ shortURLs] and step through their given configuration. Finally, mediawiki uses [[mysql]] to run a database, though this is explained when you follow the [https://www.mediawiki.org/wiki/Manual:Installation_guide installation guide].

			At this point, we have nginx pointing to port `7777` for our `fastcgi` server to run the php files. We need to configure `fpm` to do this:
			<syntaxhighlight lang="bash">
			vim /etc/php/7.4/fpm/pool.d/www.conf
			</syntaxhighlight>
			and write
			<syntaxhighlight lang="text" line start="36">
			listen = 127.0.0.1:7777
			</syntaxhighlight>

			Update everything with systemd,
			<syntaxhighlight lang="bash">
			systemctl restart nginx
			systemctl restart php7.4-fpm
			</syntaxhighlight>
			and the two sites should work.

imported>Sjwhitak: Add syntax highlighting.

2022-03-14T20:09:47Z

Add syntax highlighting.

Show changes

imported>Sjwhitak: Add flask

2022-02-24T19:42:12Z

Add flask

← Older revision		Revision as of 19:42, 24 February 2022
Line 78:		Line 78:

	To use a reverse proxy, remember the port your service is running on, and then add it into your nginx configuration:		To use a reverse proxy, remember the port your service is running on, and then add it into your nginx configuration:
			<pre>

	server {		server {
	server_name example.com;		server_name example.com;
	listen 80;		listen 80;
	listen [::]:80;		listen [::]:80;
	location / {		location / {
	proxy_pass http://localhost:8080;		proxy_pass http://localhost:8080;
	}		}
	}		}
			</pre>
	This is a simple set up for an executable running on port 8080. I would ensure your firewall does not allow outside access to these ports, else anyone can directly access the service without nginx's protection.		This is a simple set up for an executable running on port 8080. I would ensure your firewall does not allow outside access to these ports, else anyone can directly access the service without nginx's protection.

	Suppose you want multiple webapps, then:		Suppose you want multiple webapps, then:
			<pre>

	server {		server {
	server_name example.com;		server_name example.com;
	listen 80;		listen 80;
	listen [::]:80;		listen [::]:80;
	location / {		location / {
	proxy_pass http://localhost:8080; # Homepage		proxy_pass http://localhost:8080; # Homepage
	}		}
	location /tags {		location /tags {
	proxy_pass http://localhost:8081; # Cool web app 1		proxy_pass http://localhost:8081; # Cool web app 1
	}		}
	location /wiki {		location /wiki {
	proxy_pass http://localhost:8082; # Cool web app 2		proxy_pass http://localhost:8082; # Cool web app 2
	}		}
	...		...
	}		}
			</pre>
	If someone navigates to <code>example.com</code>, nginx serves them data from the service running on port <code>8080</code>.		If someone navigates to <code>example.com</code>, nginx serves them data from the service running on port <code>8080</code>.

Line 115:		Line 117:

	This shows the purpose of the [https://nginx.org/en/docs/http/ngx_http_core_module.html#location <code>location</code>] directive.		This shows the purpose of the [https://nginx.org/en/docs/http/ngx_http_core_module.html#location <code>location</code>] directive.

			=== flask ===

			Running a simple flask server can be done in Python:
			<pre>
			from flask import Flask
			app = Flask(__name__)

			@app.route('/flask')
			def main():
			return "Flask app"

			app.run(port=9999)
			</pre>

			And in nginx, the configuration should be:
			<pre>
			server {
			location /flask {
			proxy_pass http://localhost:9999;
			}
			}
			</pre>

	== <code>fastcgi</code> ==		== <code>fastcgi</code> ==

imported>Sjwhitak: More links

2022-02-23T22:22:35Z

More links

← Older revision		Revision as of 22:22, 23 February 2022
Line 12:		Line 12:

	In <code>/etc/nginx/nginx.conf</code>, <code>/etc/nginx/conf.d/.conf</code> and <code>/etc/nginx/sites-enabled/</code> are included. Therefore, if you have a complicated set up, you can split up your configuration among multiple files.		In <code>/etc/nginx/nginx.conf</code>, <code>/etc/nginx/conf.d/.conf</code> and <code>/etc/nginx/sites-enabled/</code> are included. Therefore, if you have a complicated set up, you can split up your configuration among multiple files.

			To test your configuration, <code>nginx -t</code> will tell you what syntax is wrong if there happens to be any. For instance, some directives can't be certain areas.

	== A single domain ==		== A single domain ==
Line 51:		Line 53:
	}		}
	server {		server {
	root /var/www/~~wikimedia~~;		root /var/www/mediawiki;
	index index.html;		index index.html;
	server_name wiki.example.com;		server_name wiki.example.com;
Line 110:		Line 112:
	If someone navigates to <code>example.com/wiki</code>, nginx serves them data from the service running on port <code>8082</code>.		If someone navigates to <code>example.com/wiki</code>, nginx serves them data from the service running on port <code>8082</code>.

	Why's there no <code>root</code> or <code>index</code>? It doesn't matter. nginx no longer bothers with any of that, since it's directly passing everything into the service.		Why's there no [https://nginx.org/en/docs/http/ngx_http_core_module.html#root <code>root</code>] or [https://nginx.org/en/docs/http/ngx_http_index_module.html <code>index</code>]? It doesn't matter. nginx no longer bothers with any of that, since it's directly passing everything into the service.

	This shows the purpose of the [https://nginx.org/en/docs/http/ngx_http_core_module.html#location <code>location</code>] directive.		This shows the purpose of the [https://nginx.org/en/docs/http/ngx_http_core_module.html#location <code>location</code>] directive.
Line 145:		Line 147:
	The [https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html#fastcgi_param <code>fastcgi_param</code>] directive passes in information into the fastcgi server. The rest of the params are inside <code>/etc/nginx/fastcgi_params</code>, which is only 20 or so more params.		The [https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html#fastcgi_param <code>fastcgi_param</code>] directive passes in information into the fastcgi server. The rest of the params are inside <code>/etc/nginx/fastcgi_params</code>, which is only 20 or so more params.

	We only want to run <code>*.php</code> files into the fastcgi server, so we want to make sure only files that end with <code>.php</code> are actually passed into the fastcgi server (note the <code>location</code> directive).		We only want to run <code>*.php</code> files into the fastcgi server, so we want to make sure only files that end with <code>.php</code> are actually passed into the fastcgi server (note the [https://nginx.org/en/docs/http/ngx_http_core_module.html#location <code>location</code>] directive).

	= TLS =		= TLS =
Line 208:		Line 210:
	[https://letsencrypt.org/ Let's Encrypt]'s certificates are valid for 3 months, so you can update this every 3 months when it expires. Or, have a cronjob do it for you! Type <code>crontab -e</code> and then add:		[https://letsencrypt.org/ Let's Encrypt]'s certificates are valid for 3 months, so you can update this every 3 months when it expires. Or, have a cronjob do it for you! Type <code>crontab -e</code> and then add:
	0 12 * * * /usr/bin/certbot renew --quiet		0 12 * * * /usr/bin/certbot renew --quiet

			= Examples =

			You want to run a blog that hosts static pages and a wiki that runs [https://www.mediawiki.org/wiki/MediaWiki mediawiki].