All key value pairs/triples have to be contained within the same line and have to be seperated by nothing else than one whitespace character, either or \t
Those are all the options:
- server
- listen
- root
- server_name
- autoindex
- index_page
- client_body_buffer_size
- client_max_body_size
- cgi
- cgi_bin
- location
- error_page
server { this is the only way to start a server-block
} a server-block needs to be closed before the end of the config-file or and before a new server-block starts.
Those two lines can not contain any additional content other than comments.
Comments can be initialised by either a # or a ; and will set everything behind it on the same line as comment.
This is how you can set up the ports inside a server-block.
There can be multiple ports in one server-block and the same ports can be used in different servers-blocks.
listen 8080
listen 8081;
listen 8082;
Here you can setup the root location of your server.
root /server/data/
This will be the hostname of your server.
It can not be default and it has to be unique for that config-file.
Special to this hostname will be that you are not really able to set it to anything you like as long as you are running it in 42 school and want to access the server via your browser, because for that to work you would need write access to the /etc/hosts file.
But for running tests with curl you will be able to set any hostname you like, as long as you set the appropriate flags in curl.
server_name weebserv
Here is the global option for autoindex, it can either be true or false, with false beeing the default value.
If true this will enable directory-listing if a directory was requested and no index-file is present.
autoindex true
The index_page will decide what index file to show if root was requested.
This can be any file you wish, it just has to be accessible.
index_page index.html
The client_body_buffer_size controlls the max number of byte to read from a body of a request at once.
The default of this value will be 64kB
client_body_buffer_size 104655454
This will limit the maximum accepted size of either a full body if it is not a chunked request or the size of one chunk if it is a chunked request.
Default will be set to 1GB
client_max_body_size 1000000000
Here you can set the file-extension(s) that should be treated as cgi.
With that you also need to supply the appropriate path to the executable.
cgi .file_extension handler_exe
cgi .php ./server/data/cgi-bin/php-cgi
This will define the path where the cgi binaries will be stored.
cgi_bin /server/data/cgi-bin/
The location-blocks are a powerfull tool to change file- and directory-routing to hide the backend directory structure to the user of a website.
It also controlls allowed methods, autoindexing and the index_page of a certain directory.
The following location-block will change localhost:8080/cgi/ and change it in the backend to localhost:8080/server/data/cgi-bin/.
And for this request it will show the index.cgi.
By default no methods will be allowed for a location when defined, autindex will be false and there will be no index_page set.
The default values where choosen this way to have maximum security.
Location-blocks have to start like this location /path/to/look/for/ { or like that location .fileextension { and have to be inside a server-block and can not overlap with another location-block.
They are also closed with a single }.
location /cgi/ {
root /server/data/cgi-bin/
method DELETE POST GET
index_page index.cgi
}
A location-block can also be set for a file-extension.
In this case if any .ico file is requested, doesn't matter in which directory, it will always go and search for it in server/data/images/.
location *.ico {
root /server/data/images/
method GET
autoindex false
}
This enables you to setup custom error pages for all the error pages where you don't want to show the autogenerated error page.
`error_page 404 /server/data/pages/404.html`