NGINX - Revision history

KazVee: Add Tutorials category tag to the page

2025-07-13T03:42:36Z

Add Tutorials category tag to the page

← Older revision		Revision as of 03:42, 13 July 2025
Line 109:		Line 109:
	To save a file, make sure you are not in "insert" mode, before entering <code>:wq</code> (which will '''write''', '''quit'''). If you		To save a file, make sure you are not in "insert" mode, before entering <code>:wq</code> (which will '''write''', '''quit'''). If you
	want to exit without saving your changes, enter <code>:q!</code>, which will '''force quit'''.		want to exit without saving your changes, enter <code>:q!</code>, which will '''force quit'''.

			[[Category:Tutorials]]

KazVee: Doublecheck all single "=" are as they should be & doublecheck code blocks

2025-01-22T05:52:13Z

Doublecheck all single "=" are as they should be & doublecheck code blocks

← Older revision		Revision as of 05:52, 22 January 2025
Line 1:		Line 1:
	= NGINX =		== NGINX ==

	= Preface =		== Preface ==

	NGINX is described as a "web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache".		NGINX is described as a "web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache".
Line 7:		Line 7:
	little foreign if coming from Apache's <code>.htaccess</code> override based system, there's a lot to enjoy.		little foreign if coming from Apache's <code>.htaccess</code> override based system, there's a lot to enjoy.

	= Getting Started =		== Getting Started ==

	While NGINX can be installed on a variety of systems, we'll focus on Ubuntu. As with most installations, it's highly		While NGINX can be installed on a variety of systems, we'll focus on Ubuntu. As with most installations, it's highly
Line 27:		Line 27:
	either <code>http://[Dedicated IPv4]</code> or <code>http://vps#.heliohost.us</code>, and see the default NGINX landing page.		either <code>http://[Dedicated IPv4]</code> or <code>http://vps#.heliohost.us</code>, and see the default NGINX landing page.

	= Configuring NGINX =		== Configuring NGINX ==

	= Creating a new content directory =		== Creating a new content directory ==

	While being able to see the default NGINX page is great, it's time to configure NGINX's "server blocks", which will		While being able to see the default NGINX page is great, it's time to configure NGINX's "server blocks", which will
Line 52:		Line 52:
	</pre>		</pre>

	= Creating a server block =		== Creating a server block ==

	For every domain that is associated with your VPS, you'll want to create an NGINX configuration file, known as a "server		For every domain that is associated with your VPS, you'll want to create an NGINX configuration file, known as a "server block", located in <code>/etc/nginx/sites-available</code>. For example, we'll create one for our VPS with <code>sudo vi /etc/nginx/sites-available/[domain name]</code> (no file ending like ".txt" or ".json", only your domain name).
	block", located in <code>/etc/nginx/sites-available</code>. For example, we'll create one for our VPS		For a brief Vim tutorial, see [[:#Using_Vim\|here]]. Enter "insert" mode using "i", and paste the following default code block:
	with <code>sudo vi /etc/nginx/sites-available/[domain name]</code> (no file ending like ".txt" or ".json", only your domain name).
	For a brief Vim tutorial, see [[:#Using_Vim\|here]]. Enter "insert" mode using "i", and paste the following default code
	block:

	<pre>		<pre>
Line 76:		Line 73:
	</pre>		</pre>

	Once again, __make sure to edit all the references to match your own domain name__. Once you're finished, press "ESC",		Once again, __make sure to edit all the references to match your own domain name__. Once you're finished, press "ESC", followed by <code>:wq</code>. If you get an error saying "This file is readonly", make sure you are editing the file with <code>sudo</code> permissions.
	followed by <code>:wq</code>. If you get an error saying "This file is readonly", make sure you are editing the file with <code>sudo</code>
	permissions.

	Now you may have noticed we created this configuration file in <code>sites-available</code>, '''not''' <code>sites-enabled</code>. Let's rectify		Now you may have noticed we created this configuration file in <code>sites-available</code>, '''not''' <code>sites-enabled</code>. Let's rectify
	that, using a symbolic link (which is, in layman's terms, a shortcut for the system to find the original file in another		that, using a symbolic link (which is, in layman's terms, a shortcut for the system to find the original file in another path). Using <code>sudo ln -s /etc/nginx/sites-available/[domain name] /etc/nginx/sites-enabled/</code>, we can accomplish that task.
	path). Using <code>sudo ln -s /etc/nginx/sites-available/[domain name] /etc/nginx/sites-enabled/</code>, we can accomplish that
	task.

	An easy way to check if everything's configured correctly, is to use <code>sudo nginx -t</code>, which will validate your NGINX		An easy way to check if everything's configured correctly, is to use <code>sudo nginx -t</code>, which will validate your NGINX configuration.
	configuration.

	To update our changes, we can use <code>sudo systemctl nginx restart</code>, which will restart NGINX.		To update our changes, we can use <code>sudo systemctl nginx restart</code>, which will restart NGINX.
Line 92:		Line 84:
	Congratulations, you should now see your HTML page served from your VPS to your browser!		Congratulations, you should now see your HTML page served from your VPS to your browser!

	= Adding SSL =		== Adding SSL ==

	No website is complete (or secure) without SSL! As everyone else, we'll use [https://letsencrypt.org/ Let's Encrypt] to achieve this.		No website is complete (or secure) without SSL! As everyone else, we'll use [https://letsencrypt.org/ Let's Encrypt] to achieve this.
Line 103:		Line 95:
	Your website will now be secure with SSL, and your SSL certificate will be automatically renewed every three months.		Your website will now be secure with SSL, and your SSL certificate will be automatically renewed every three months.

	= Using Vim =		== Using Vim ==

	Vim is the default text editor for most Unix based systems. While it's a ubiquitous program, it's infamous for being		Vim is the default text editor for most Unix based systems. While it's a ubiquitous program, it's infamous for being

KazVee: Fix link to Using Vim section

2025-01-22T01:23:14Z

Fix link to Using Vim section

← Older revision		Revision as of 01:23, 22 January 2025
Line 57:		Line 57:
	block", located in <code>/etc/nginx/sites-available</code>. For example, we'll create one for our VPS		block", located in <code>/etc/nginx/sites-available</code>. For example, we'll create one for our VPS
	with <code>sudo vi /etc/nginx/sites-available/[domain name]</code> (no file ending like ".txt" or ".json", only your domain name).		with <code>sudo vi /etc/nginx/sites-available/[domain name]</code> (no file ending like ".txt" or ".json", only your domain name).
	For a brief Vim tutorial, see [[:Using_Vim\|here]]. Enter "insert" mode using "i", and paste the following default code		For a brief Vim tutorial, see [[:#Using_Vim\|here]]. Enter "insert" mode using "i", and paste the following default code
	block:		block:

KazVee: Use code tag to replace backticks which don't render properly

2025-01-22T01:21:47Z

Use code tag to replace backticks which don't render properly

← Older revision		Revision as of 01:21, 22 January 2025
Line 24:		Line 24:
	Using "UFW" (Universal Fire Wall), we can see using <code>sudo ufw app list</code> that NGINX has added three new profiles for us		Using "UFW" (Universal Fire Wall), we can see using <code>sudo ufw app list</code> that NGINX has added three new profiles for us
	to choose from ('Nginx Full', 'Nginx HTTP', 'Nginx HTTPS'). For our purposes, we'll enable 'Nginx Full'		to choose from ('Nginx Full', 'Nginx HTTP', 'Nginx HTTPS'). For our purposes, we'll enable 'Nginx Full'
	using <code>sudo ufw allow 'Nginx Full'</code>. Now we should be able to see our VPS from a web browser, using		using <code>sudo ufw allow 'Nginx Full'</code>. ''Now'' we should be able to see our VPS from a web browser, using
	either <code>http://[Dedicated IPv4]</code> or <code>http://vps#.heliohost.us</code>, and see the default NGINX landing page.		either <code>http://[Dedicated IPv4]</code> or <code>http://vps#.heliohost.us</code>, and see the default NGINX landing page.

Line 33:		Line 33:
	While being able to see the default NGINX page is great, it's time to configure NGINX's "server blocks", which will		While being able to see the default NGINX page is great, it's time to configure NGINX's "server blocks", which will
	allow us to define how NGINX behaves on a "per-domain" basis. Let's start by creating a new directory for our web		allow us to define how NGINX behaves on a "per-domain" basis. Let's start by creating a new directory for our web
	content, using `sudo mkdir -p /var/www/[domain name]/html` (replace "[domain name]" with your own). In this case, `-p`		content, using <code>sudo mkdir -p /var/www/[domain name]/html</code> (replace "[domain name]" with your own). In this case, <code>-p</code> is used to create any missing parent directories, while <code>sudo</code> is used as the <code>/var</code> directory is system-protected.
	is used to create any missing parent directories, while `sudo` is used as the `/var` directory is system-protected.

	Now, we can make our life easier by changing the owner and permissions of our new folder, so we won't have to repeatedly		Now, we can make our life easier by changing the owner and permissions of our new folder, so we won't have to repeatedly use <code>sudo</code> permissions to access our own content. Using <code>sudo chown -R $USER:$USER /var/www/[domain name]/html</code>, we can "change owner" to our current user (<code>-R</code> applies the command recursively to all the contents, if applicable). We also need to set the directory's permissions, using <code>sudo chmod -R 755 /var/www/[domain name]</code> (chmod means "change mode", while 755 is the numerical representation of "read and execute access for everyone, write access for the owner").
	use `sudo` permissions to access our own content. Using `sudo chown -R $USER:$USER /var/www/[domain name]/html`, we
	can "change owner" to our current user (`-R` applies the command recursively to all the contents, if applicable). We
	also need to set the directory's permissions, using `sudo chmod -R 755 /var/www/[domain name]` (chmod means "change
	mode", while 755 is the numerical representation of "read and execute access for everyone, write access for the owner").

	Any file we save in this new directory will be served using NGINX. As a simple test, we'll create a simple HTML file as		Any file we save in this new directory will be served using NGINX. As a simple test, we'll create a simple HTML file as follows:
	follows:

	<pre>		<pre>
Line 61:		Line 55:

	For every domain that is associated with your VPS, you'll want to create an NGINX configuration file, known as a "server		For every domain that is associated with your VPS, you'll want to create an NGINX configuration file, known as a "server
	block", located in `/etc/nginx/sites-available`. For example, we'll create one for our VPS		block", located in <code>/etc/nginx/sites-available</code>. For example, we'll create one for our VPS
	with `sudo vi /etc/nginx/sites-available/[domain name]` (no file ending like ".txt" or ".json", only your domain name).		with <code>sudo vi /etc/nginx/sites-available/[domain name]</code> (no file ending like ".txt" or ".json", only your domain name).
	For a brief Vim tutorial, see [here]~~(#using-vim)~~. Enter "insert" mode using "i", and paste the following default code		For a brief Vim tutorial, see [[:Using_Vim\|here]]. Enter "insert" mode using "i", and paste the following default code
	block:		block:

Line 83:		Line 77:

	Once again, __make sure to edit all the references to match your own domain name__. Once you're finished, press "ESC",		Once again, __make sure to edit all the references to match your own domain name__. Once you're finished, press "ESC",
	followed by `:wq`. If you get an error saying "This file is readonly", make sure you are editing the file with `sudo`		followed by <code>:wq</code>. If you get an error saying "This file is readonly", make sure you are editing the file with <code>sudo</code>
	permissions.		permissions.

	Now you may have noticed we created this configuration file in `sites-available`, '''not''' `sites-enabled`. Let's rectify		Now you may have noticed we created this configuration file in <code>sites-available</code>, '''not''' <code>sites-enabled</code>. Let's rectify
	that, using a symbolic link (which is, in layman's terms, a shortcut for the system to find the original file in another		that, using a symbolic link (which is, in layman's terms, a shortcut for the system to find the original file in another
	path). Using `sudo ln -s /etc/nginx/sites-available/[domain name] /etc/nginx/sites-enabled/`, we can accomplish that		path). Using <code>sudo ln -s /etc/nginx/sites-available/[domain name] /etc/nginx/sites-enabled/</code>, we can accomplish that
	task.		task.

	An easy way to check if everything's configured correctly, is to use `sudo nginx -t`, which will validate your NGINX		An easy way to check if everything's configured correctly, is to use <code>sudo nginx -t</code>, which will validate your NGINX
	configuration.		configuration.

	To update our changes, we can use `sudo systemctl nginx restart`, which will restart NGINX.		To update our changes, we can use <code>sudo systemctl nginx restart</code>, which will restart NGINX.

	Congratulations, you should now see your HTML page served from your VPS to your browser!		Congratulations, you should now see your HTML page served from your VPS to your browser!
Line 103:		Line 97:

	First, we'll need to install Certbot, which is a commandline utility for automating the process.		First, we'll need to install Certbot, which is a commandline utility for automating the process.
	Run `sudo apt install certbot python3-certbot-nginx` ('''not the same as the Apache version'''), which will install Certbot and its dependencies.		Run <code>sudo apt install certbot python3-certbot-nginx</code> ('''not the same as the Apache version'''), which will install Certbot and its dependencies.

	Now we can get a certificate. Run `sudo certbot --nginx -d yourdomain.com`, and follow the on-screen instructions to complete the process. Make sure you enabled SSL using UFW!		Now we can get a certificate. Run <code>sudo certbot --nginx -d yourdomain.com</code>, and follow the on-screen instructions to complete the process. Make sure you enabled SSL using UFW!

	Your website will now be secure with SSL, and your SSL certificate will be automatically renewed every three months.		Your website will now be secure with SSL, and your SSL certificate will be automatically renewed every three months.
Line 115:		Line 109:
	may not be as hard as it seems.		may not be as hard as it seems.

	To edit a file, use `vi file.txt`, which will open the Vim interface. If you supply a nonexistent filename, Vim will		To edit a file, use <code>vi file.txt</code>, which will open the Vim interface. If you supply a nonexistent filename, Vim will
	create a file instead.		create a file instead.

Line 121:		Line 115:
	To exit "insert" mode, press "ESC".		To exit "insert" mode, press "ESC".

	To save a file, make sure you are not in "insert" mode, before entering `:wq` (which will '''write''', '''quit'''). If you		To save a file, make sure you are not in "insert" mode, before entering <code>:wq</code> (which will '''write''', '''quit'''). If you
	want to exit without saving your changes, enter `:q!`, which will '''force quit'''.		want to exit without saving your changes, enter <code>:q!</code>, which will '''force quit'''.

KazVee: /* Testing */

2024-11-01T02:40:20Z

Testing

← Older revision		Revision as of 02:40, 1 November 2024
Line 8:		Line 8:

	= Getting Started =		= Getting Started =

	~~= Testing =~~

	~~using <pre>sudo apt update && sudo apt upgrade</pre>.~~

	~~<pre><code>~~
	~~This is a block of code.~~
	~~It will retain whitespace formatting.~~
	~~</code></pre>~~

	While NGINX can be installed on a variety of systems, we'll focus on Ubuntu. As with most installations, it's highly		While NGINX can be installed on a variety of systems, we'll focus on Ubuntu. As with most installations, it's highly

KazVee: /* Testing */

2024-11-01T02:38:43Z

Testing

← Older revision		Revision as of 02:38, 1 November 2024
Line 10:		Line 10:

	= Testing =		= Testing =

			using <pre>sudo apt update && sudo apt upgrade</pre>.

	<pre><code>		<pre><code>

KazVee: /* Getting Started */

2024-11-01T02:38:12Z

Getting Started

← Older revision		Revision as of 02:38, 1 November 2024
Line 8:		Line 8:

	= Getting Started =		= Getting Started =

			= Testing =

			<pre><code>
			This is a block of code.
			It will retain whitespace formatting.
			</code></pre>

	While NGINX can be installed on a variety of systems, we'll focus on Ubuntu. As with most installations, it's highly		While NGINX can be installed on a variety of systems, we'll focus on Ubuntu. As with most installations, it's highly

Unknown025: /* Getting Started */

2024-10-31T01:20:23Z

Getting Started

Unknown025: /* Preface */

2024-10-31T01:18:36Z

Preface

← Older revision		Revision as of 01:18, 31 October 2024
Line 5:		Line 5:
	NGINX is described as a "web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache".		NGINX is described as a "web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache".
	In practice, it's a powerful alternative to Apache, as it's more memory efficient. While configuring NGINX may seem a		In practice, it's a powerful alternative to Apache, as it's more memory efficient. While configuring NGINX may seem a
	little foreign if coming from Apache's `.htaccess` override based system, there's a lot to enjoy.		little foreign if coming from Apache's <code>.htaccess</code> override based system, there's a lot to enjoy.

	= Getting Started =		= Getting Started =

KazVee: /* Adding SSL */

2024-10-17T18:30:22Z

Adding SSL

← Older revision		Revision as of 18:30, 17 October 2024
Line 100:		Line 100:
	= Adding SSL =		= Adding SSL =

	No website is complete (or secure) without SSL! As everyone else, we'll use [~~Let's Encrypt](~~https://letsencrypt.org/) to		No website is complete (or secure) without SSL! As everyone else, we'll use [https://letsencrypt.org/ Let's Encrypt] to achieve this.
	achieve this.

	First, we'll need to install Certbot, which is a commandline utility for automating the process.		First, we'll need to install Certbot, which is a commandline utility for automating the process.
	Run `sudo apt install certbot python3-certbot-nginx` ('''not the same as the Apache version'''), which will install		Run `sudo apt install certbot python3-certbot-nginx` ('''not the same as the Apache version'''), which will install Certbot and its dependencies.
	Certbot and its dependencies.

	Now we can get a certificate. Run `sudo certbot --nginx -d yourdomain.com`, and follow the on-screen instructions to		Now we can get a certificate. Run `sudo certbot --nginx -d yourdomain.com`, and follow the on-screen instructions to complete the process. Make sure you enabled SSL using UFW!
	complete the process. Make sure you enabled SSL using UFW!

	Your website will now be secure with SSL, and your SSL certificate will be automatically renewed every three months.		Your website will now be secure with SSL, and your SSL certificate will be automatically renewed every three months.

← Older revision		Revision as of 01:20, 31 October 2024
Line 10:		Line 10:

	While NGINX can be installed on a variety of systems, we'll focus on Ubuntu. As with most installations, it's highly		While NGINX can be installed on a variety of systems, we'll focus on Ubuntu. As with most installations, it's highly
	recommended to update your system beforehand, using `sudo apt update && sudo apt upgrade`.		recommended to update your system beforehand, using <code>sudo apt update && sudo apt upgrade</code>.

	{{Danger\|		{{Danger\|
	Using `sudo` is equivalent to running a command with root/administrative privileges! While		Using <code>sudo</code> is equivalent to running a command with root/administrative privileges! While
	this tutorial relies heavily on its usage, most normal commands '''should not''' be run with the `sudo` prefix, as that's		this tutorial relies heavily on its usage, most normal commands '''should not''' be run with the <code>sudo</code> prefix, as that's
	a surefire way to potentially cause irreversible damage to your system configuration.		a surefire way to potentially cause irreversible damage to your system configuration.
	}}		}}

	With our system up-to-date, we can now run `sudo apt install nginx`. This command will install and configure a default		With our system up-to-date, we can now run <code>sudo apt install nginx</code>. This command will install and configure a default
	installation of NGINX, which means we should be able to access our VPS from a web browser...as soon as we configure our		installation of NGINX, which means we should be able to access our VPS from a web browser...as soon as we configure our
	firewall.		firewall.

	Using "UFW" (Universal Fire Wall), we can see using `sudo ufw app list` that NGINX has added three new profiles for us		Using "UFW" (Universal Fire Wall), we can see using <code>sudo ufw app list</code> that NGINX has added three new profiles for us
	to choose from ('Nginx Full', 'Nginx HTTP', 'Nginx HTTPS'). For our purposes, we'll enable 'Nginx Full'		to choose from ('Nginx Full', 'Nginx HTTP', 'Nginx HTTPS'). For our purposes, we'll enable 'Nginx Full'
	using `sudo ufw allow 'Nginx Full'`. Now we should be able to see our VPS from a web browser, using		using <code>sudo ufw allow 'Nginx Full'</code>. Now we should be able to see our VPS from a web browser, using
	either `http://[Dedicated IPv4]` or `http://vps#.heliohost.us`, and see the default NGINX landing page.		either <code>http://[Dedicated IPv4]</code> or <code>http://vps#.heliohost.us</code>, and see the default NGINX landing page.

	= Configuring NGINX =		= Configuring NGINX =