Difference between pages "Package:Nginx" and "Install/BootLoader"

(Difference between pages)
 
(Emerging GRUB)
 
Line 1: Line 1:
{{Ebuild
+
<noinclude>
|Summary=Robust, small and high performance HTTP and reverse proxy server
+
{{InstallPart|boot loader configuration}}
|CatPkg=www-servers/nginx
+
</noinclude>
|Maintainer=Drobbins
+
=== Installing a Bootloader ===
|Repository=Funtoo Overlay
+
|Overlay=Funtoo
+
}}
+
[[Image:nginx.gif|frame]]
+
  
nginx (pronounced "engin-x") is a Web and reverse proxy server for HTTP, SMTP, POP3 and IMAP protocols. It focuses on high concurrency, performance and low memory usage. Nginx quickly delivers static content with efficient use of system resources, also dynamic content is delivered on a network using FastCGI, SCGI handlers for scripts, uWSGI application servers or Phusion Passenger module (atm broken in [http://funtoo.org funtoo]), further more it can serve a very capable software load balancer. It uses an asynchronos event-driven approach to handle requests which provides more predictable performance under load, in contrast to the Apache HTTP server model, that uses a threaded or process-oriented approach to handling request. Nginx is licensed under a BSD-like license and it runs on Unix, Linux, BSD variants, Mac OS X, Solaris, AIX and Microsoft Windows.  
+
These install instructions show you how to use GRUB to boot using BIOS (old-school) or UEFI (new-school).
  
== Installation ==
+
==== Old School (BIOS) ====
  
=== USE flags ===
+
If you're using the BIOS to boot, setting up GRUB, the bootloader, is pretty easy.
  
Before you can install nginx, the following USE-flags are available, these can be set by ''/etc/portage/package.use'' or ''/etc/portage/package.use/nginx'', depending on your setup.
+
To use this recommended boot method, first emerge <code>boot-update</code>. This will also cause <code>grub-2</code> to be merged, since it is a dependency of <code>boot-update</code>.
  
{{SectionNeedsUpdates}}
+
<console>
 +
(chroot) # ##i##emerge boot-update
 +
</console>
  
{| class="wikitable" style="margin: 1em auto;" width=80%
+
Then, edit <code>/etc/boot.conf</code> and specify "<code>Funtoo Linux genkernel</code>" as the <code>default</code> setting at the top of the file, replacing <code>"Funtoo Linux"</code>.  
! width="20%" | Use flag
+
! width="10%" | Default
+
! width="10%" | Recommended
+
! width="60%" | Description
+
|-
+
| style="text-align:center;" | aio
+
| style="text-align:center;" | ?
+
| style="text-align:center;" | ?
+
| Enables file AIO support.
+
|-
+
| style="text-align:center;" | debug
+
| style="text-align:center;" | ?
+
| style="text-align:center;" | ?
+
| Enables extra debug codepaths, like asserts and extra output.
+
|-
+
| style="text-align:center;" | http
+
| style="text-align:center;" | ?
+
| style="text-align:center;" | ?
+
| Enables http serving.
+
|-
+
| style="text-align:center;" | http-cache
+
| style="text-align:center;" | ?
+
| style="text-align:center;" | ?
+
| Enables caching for http files.
+
|-
+
| style="text-align:center;" | ipv6
+
| style="text-align:center;" | ?
+
| style="text-align:center;" | ?
+
| Enables IPv6 support.
+
|-
+
| style="text-align:center;" | libatomic
+
| style="text-align:center;" | ?
+
| style="text-align:center;" | ?
+
| Use libatomic instead of builtin atomic operations.
+
|-
+
| style="text-align:center;" | pcre
+
| style="text-align:center;" | ?
+
| style="text-align:center;" | ?
+
| Enables support for Perl Compatible Regular Expressions.
+
|-
+
| style="text-align:center;" | ssl
+
| style="text-align:center;" | ?
+
| style="text-align:center;" | ?
+
| Adds support for Secure Socket Layer connections.
+
|-
+
| style="text-align:center;" | vim-syntax
+
| style="text-align:center;" | ?
+
| style="text-align:center;" | ?
+
| Pulls in related vim syntax scripts.
+
|}
+
Furthermore, you can set the nginx modules you like to use in ''/etc/make.conf'' in the NGINX_MODULES_HTTP variable as NGINX_MODULES_HTTP="variables".
+
  
=== USE Expanded flags ===
+
<code>/etc/boot.conf</code> should now look like this:
  
nginx USE-flags go into ''/etc/portage/package.use'' or ''/etc/portage/package.use/nginx'', while the HTTP and MAIL modules go as NGINX_MODULES_HTTP or NGINX_MODULES_MAIL are stored in /etc/make.conf. And as you wouldn't server only static html files, but most commonly also php files/scripts you should also install php with fpm enabled and xcache for caching the content, what makes your nginx setup way faster. For xcache you need to set PHP_TARGETS="php5-3" in '/etc/make.conf'.
+
<pre>
 +
boot {
 +
generate grub
 +
default "Funtoo Linux genkernel"
 +
timeout 3
 +
}
 +
 
 +
"Funtoo Linux" {
 +
kernel bzImage[-v]
 +
}
 +
 
 +
"Funtoo Linux genkernel" {
 +
kernel kernel[-v]
 +
initrd initramfs[-v]
 +
params += real_root=auto
 +
}
 +
 
 +
"Funtoo Linux better-initramfs" {
 +
kernel vmlinuz[-v]
 +
initrd /initramfs.cpio.gz
 +
}
 +
</pre>
 +
 
 +
Please read <code>man boot.conf</code> for further details.
 +
 
 +
===== Running grub-install and boot-update =====
 +
 
 +
Finally, we will need to actually install the GRUB boot loader to your disk, and also run <code>boot-update</code> which will generate your boot loader configuration file:
  
Example:
 
 
<console>
 
<console>
###i## echo "www-servers/nginx USE-FLAG-List" >> /etc/portage/package.use/nginx
+
(chroot) # ##i##grub-install --no-floppy /dev/sda
 +
(chroot) # ##i##boot-update
 
</console>
 
</console>
  
=== Emerging nginx ===
+
Now you need to update your boot loader configuration file:
 
+
Now you are ready to install nginx with php and xcache support:
+
 
<console>
 
<console>
###i## emerge -avt nginx php xcache
+
(chroot) # ##i##boot-update
 
</console>
 
</console>
so now just check your useflags and press enter to start emerge.
+
You only need to run <code>grub-install</code> when you first install Funtoo Linux, but you need to re-run <code>boot-update</code> every time you modify your <code>/etc/boot.conf</code> file, so your changes are applied on next boot.
  
== Configuring ==
+
==== New School (UEFI) ====
  
All configuration is done in ''/etc/nginx'' with ''nginx.conf'' as the main configuration file and all virtual hosts in ''/etc/nginx/sites/available'' while you have to symlink ''/etc/nginx/sites-available/{VHOST}'' to ''/etc/nginx/sites-enabled/{VHOST}'' to activate them. An example config for such a {VHOST} looks like that:
+
If you're using UEFI to boot, setting up the boot loader is a bit more complicated for now, but this process will be improving soon. Perform the following steps.
 +
 
 +
===== Emerging GRUB =====
 +
 
 +
You will still use GRUB as a boot loader, but before emerging grub, you will need to enable EFI booting. To do this,
 +
add the following line to <code>/etc/make.conf</code>:
 +
 
 +
For x86-64bit systems:
  
 
<pre>
 
<pre>
server {
+
GRUB_PLATFORMS="efi-64"
    listen          80;
+
</pre>
    server_name    www.example.com;
+
  
    access_log      /var/log/nginx/www.example.com.access_log main;
+
For x86-32bit systems:
    error_log      /var/log/nginx/www.example.com.error_log info;
+
  
    root /var/www/www.example.com/htdocs;
+
<pre>
}
+
GRUB_PLATFORMS="efi-32"
</pre>  
+
</pre>
  
The ''nginx.conf'' and ''sites-available/localhost'' file is well commented. Customize it to your needs. Make sure you set the listen option correctly. By default, the listen option is set to listen on the loopback interface. If you leave this unchanged other computers on the network will not be able to connect to the server.
+
Then, <code>emerge boot-update</code>. You will notice <code>grub</code> and <code>efibootmgr</code> getting pulled in as dependencies. This is expected and good:
  
== Location Processing Order ==
+
<console>
One often confusing aspect of nginx configuration is the order in which it processes location directives. This section is intended to clarify the confusion and help you to write secure nginx location directives.
+
(chroot) # ##i##emerge boot-update
 +
</console>
  
=== Two basic types of Location directives ===
+
===== Installing GRUB =====
There are two basic types of location directives. The first is called a "conventional string", and looks something like this:
+
location /foo { deny all; }
+
The second basic type of location directive is a regex, or regular expression block. In its most basic form, it looks like this, with a "~" and then a regular expression that is matched against the request path. "^" can be used to match the beginning of the request path, and "$" can be used to match the end of the request path. If you need to match a ".", you must escape it as "\." as per regular expression matching rules:
+
location ~ \.php$ { blah; }
+
  
=== The basic algorithm ===
+
Now, for the magic of getting everything in place for booting. You should copy your kernel and initramfs (if you have one -- you will if you are following the default install) to <tt>/boot</tt>. GRUB will boot those. But how do we get UEFI to boot GRUB? Well, we need to run the following command (for 32 bit simply set it as i386-efi):
Nginx uses a special algorithm to find the proper location string to match the incoming request. The basic concept to remember is that conventional string directives are placed in one "bucket", and then regular expression strings are placed in another "bucket". Nginx will use the first regular expression match that it finds, when scanning the file from top to bottom. If no matching regular expression is found, nginx will look in its "conventional string" bucket, and try to find a match. In the case of the conventional string matches, the most ''specific'' match will be used, in other words, the one will be used that matches the greatest number of characters in the request path.
+
  
This is the foundation for nginx location processing, so always use these rules as a starting point for understanding location matching order. Nginx then provides various sub-types of location directives which modify this default behavior in a number of ways. This will be covered in the next section.
+
<console>
 +
(chroot) # ##i##grub-install --target=x86_64-efi --efi-directory=/boot --bootloader-id="Funtoo Linux [GRUB]" --recheck /dev/sda
 +
</console>
 +
This command will simply install all the stuff to <tt>/boot/EFI</tt> and <tt>/boot/grub</tt> that your system needs to boot. In particular, the <tt>/boot/EFI/grub/grubx64.efi</tt> file will be created. This is the GRUB boot image that UEFI will load and start.
  
== Advanced Location Processing ==
+
A more detailed explanation of the flags used in the above command:
Always use the location processing logic described in the previous section as the foundation for understanding how nginx finds a matching location directive, and then once you are comfortable with how this works, read about these more advanced directives and understand how they fit into nginx's overall logic.
+
* <code>--target=x86_64-efi</code>: Tells GRUB that we want to install it in a way that allows it to boot in UEFI
 +
* <code>--efi-directory=/boot</code>: All GRUB UEFI files will be installed in ''/boot''
 +
* <code>--bootloader-id="Funtoo Linux [GRUB]"</code>: This flag is not necessary for GRUB to boot. However, it allows you to change the text of the boot option in the UEFI BIOS. The stuff in the quotes can be set to anything that you would like.
 +
* <code>--recheck</code>: If a device map already exists on the disk or partition that GRUB is being installed on, it will be removed.
 +
* <code>/dev/sda</code>:The device that we are installing GRUB on.
  
=== = (equals) Location ===
+
===== Configuring GRUB =====
One advanced location directive is the "=" location, which can be considered a variant of a "conventional string" directive. "=" directives are searched before all other directives, and if a match found, then the corresponding location block is used. A "=" location must the requested path ''exactly'' and ''completely''. For example, the following location block will match only the request /foo/bar, but not /foo/bar/oni.html:
+
location = /foo/bar { deny all; }
+
  
=== ~* (case-insensitive regex) Location ===
+
OK, now UEFI has the GRUB image it needs to boot. But we still need to configure GRUB itself so it finds and boots your kernel and initramfs. This is done by performing the following steps. Since boot-update doesn't yet support UEFI, we will use boot-update, but then edit our <code>/boot/grub/grub.cfg</code> to support UEFI booting.  
A "~*" regex match is just like a regular "~" regex match, except matches will be performed in a case-insensitive manner. "~*" location directives, being regex directives, fall into the regex "bucket" and are processed along other regex directives. This means that they are processed in the order they appear in your configuration file and the first match will be used -- assuming no "=" directives match.
+
  
=== ^~ (short-circuit conventional string) Location ===
+
First, you will need to edit <code>/etc/boot.conf</code>. Format this as you would if you were booting without UEFI. If you are not sure how this should look, below is an example of what it could look like if you are booting from an unencrypted ext4 partition:
You may think that a "^~" location is a regex location, but it is not. It is a variant of a conventional string location. If you recall, nginx will search for conventional string matches by finding the ''most specific'' match. However, when you use a "^~" location, nginx behavior is modified. Imagine the way a conventional string match works. Nginx scans your configuration file, looking at each conventional string match from line 1 to the end of file, but it scans ''all'' conventional string matches to find the ''best'' match. Well, the "~^" location match short-circuits this process. If, in the process of scanning each conventional string match in the config file, nginx encounters a "^~" match that matches the current request path, then nginx will apply this match, and stop looking for the ''best'' match.
+
  
== Ebuild Update Protocol ==
+
{{file|name=/etc/boot.conf|desc=|body=
 +
boot {
 +
        generate grub
 +
        default "Funtoo Linux"
 +
        timeout 3
 +
}
  
To work on a new version of the ebuild, perform the following steps.
+
"Funtoo Linux" {
 +
        kernel vmlinuz[-v]
 +
        params += rootfstype=ext4 root=/dev/sda2
 +
}
 +
}}
  
First, temporarily set the following settings in <tt>/etc/make.conf</tt>:
+
After you have edited your <code>/etc/boot.conf</code> file, run <code>boot-update</code>. You should now have a <code>/boot/grub/grub.cfg</code> file, which you can edit using the following command:
  
<syntaxhighlight lang="bash">
+
<console>
NGINX_MODULES_HTTP="*"
+
# ##i##nano /boot/grub/grub.cfg
NGINX_MODULES_MAIL="*"
+
</console>
</syntaxhighlight>
+
  
This will enable all available modules for nginx.
 
  
Now, create a new version of the ebuild in your overlay, and look at all the modules listed at the top of the ebuild. Visit the URLs in the comments above each one and ensure that the latest versions of each are included. Now run <tt>ebuild nginx-x.y.ebuild clean install</tt> to ensure that all modules patch/build properly. Basic build testing is now complete.
+
To get your <code>/boot/grub/grub.cfg</code> to support booting with UEFI, make the following changes. Below the existing insmod lines, add the following lines.  Both of these involve adding support for the UEFI framebuffer to GRUB.:
{{EbuildFooter}}
+
 
 +
<pre>
 +
  insmod efi_gop
 +
  insmod efi_uga
 +
</pre>
 +
 
 +
Then, change the <code>set gfxpayload</code> line to read as follows. UEFI does not support text mode, so we will keep video initialized to the current resolution.:
 +
 
 +
<pre>
 +
  set gfxpayload=keep
 +
</pre>
 +
 
 +
You can now save your changes by pressing <code>Control-X</code> and answering <code>y</code> when asked if you want to save the modified buffer. When prompted for a filename, hit Enter to use the existing filename.

Revision as of 19:48, January 1, 2015


Note

This is a template that is used as part of the Installation instructions which covers: boot loader configuration. Templates are being used to allow multiple variant install guides that use most of the same re-usable parts.


Installing a Bootloader

These install instructions show you how to use GRUB to boot using BIOS (old-school) or UEFI (new-school).

Old School (BIOS)

If you're using the BIOS to boot, setting up GRUB, the bootloader, is pretty easy.

To use this recommended boot method, first emerge boot-update. This will also cause grub-2 to be merged, since it is a dependency of boot-update.

(chroot) # emerge boot-update

Then, edit /etc/boot.conf and specify "Funtoo Linux genkernel" as the default setting at the top of the file, replacing "Funtoo Linux".

/etc/boot.conf should now look like this:

boot {
	generate grub
	default "Funtoo Linux genkernel" 
	timeout 3 
}

"Funtoo Linux" {
	kernel bzImage[-v]
}

"Funtoo Linux genkernel" {
	kernel kernel[-v]
	initrd initramfs[-v]
	params += real_root=auto 
} 

"Funtoo Linux better-initramfs" {
	kernel vmlinuz[-v]
	initrd /initramfs.cpio.gz
}

Please read man boot.conf for further details.

Running grub-install and boot-update

Finally, we will need to actually install the GRUB boot loader to your disk, and also run boot-update which will generate your boot loader configuration file:

(chroot) # grub-install --no-floppy /dev/sda
(chroot) # boot-update

Now you need to update your boot loader configuration file:

(chroot) # boot-update

You only need to run grub-install when you first install Funtoo Linux, but you need to re-run boot-update every time you modify your /etc/boot.conf file, so your changes are applied on next boot.

New School (UEFI)

If you're using UEFI to boot, setting up the boot loader is a bit more complicated for now, but this process will be improving soon. Perform the following steps.

Emerging GRUB

You will still use GRUB as a boot loader, but before emerging grub, you will need to enable EFI booting. To do this, add the following line to /etc/make.conf:

For x86-64bit systems:

GRUB_PLATFORMS="efi-64"

For x86-32bit systems:

GRUB_PLATFORMS="efi-32"

Then, emerge boot-update. You will notice grub and efibootmgr getting pulled in as dependencies. This is expected and good:

(chroot) # emerge boot-update
Installing GRUB

Now, for the magic of getting everything in place for booting. You should copy your kernel and initramfs (if you have one -- you will if you are following the default install) to /boot. GRUB will boot those. But how do we get UEFI to boot GRUB? Well, we need to run the following command (for 32 bit simply set it as i386-efi):

(chroot) # grub-install --target=x86_64-efi --efi-directory=/boot --bootloader-id="Funtoo Linux [GRUB]" --recheck /dev/sda

This command will simply install all the stuff to /boot/EFI and /boot/grub that your system needs to boot. In particular, the /boot/EFI/grub/grubx64.efi file will be created. This is the GRUB boot image that UEFI will load and start.

A more detailed explanation of the flags used in the above command:

  • --target=x86_64-efi: Tells GRUB that we want to install it in a way that allows it to boot in UEFI
  • --efi-directory=/boot: All GRUB UEFI files will be installed in /boot
  • --bootloader-id="Funtoo Linux [GRUB]": This flag is not necessary for GRUB to boot. However, it allows you to change the text of the boot option in the UEFI BIOS. The stuff in the quotes can be set to anything that you would like.
  • --recheck: If a device map already exists on the disk or partition that GRUB is being installed on, it will be removed.
  • /dev/sda:The device that we are installing GRUB on.
Configuring GRUB

OK, now UEFI has the GRUB image it needs to boot. But we still need to configure GRUB itself so it finds and boots your kernel and initramfs. This is done by performing the following steps. Since boot-update doesn't yet support UEFI, we will use boot-update, but then edit our /boot/grub/grub.cfg to support UEFI booting.

First, you will need to edit /etc/boot.conf. Format this as you would if you were booting without UEFI. If you are not sure how this should look, below is an example of what it could look like if you are booting from an unencrypted ext4 partition:

/etc/boot.conf
boot {
        generate grub
        default "Funtoo Linux"
        timeout 3
}

"Funtoo Linux" {
        kernel vmlinuz[-v]
        params += rootfstype=ext4 root=/dev/sda2
}

After you have edited your /etc/boot.conf file, run boot-update. You should now have a /boot/grub/grub.cfg file, which you can edit using the following command:

# nano /boot/grub/grub.cfg


To get your /boot/grub/grub.cfg to support booting with UEFI, make the following changes. Below the existing insmod lines, add the following lines. Both of these involve adding support for the UEFI framebuffer to GRUB.:

  insmod efi_gop
  insmod efi_uga

Then, change the set gfxpayload line to read as follows. UEFI does not support text mode, so we will keep video initialized to the current resolution.:

  set gfxpayload=keep

You can now save your changes by pressing Control-X and answering y when asked if you want to save the modified buffer. When prompted for a filename, hit Enter to use the existing filename.