Webserv is a project that involves building an NGINX-like server in C++98. The project aims to provide an understanding of how web servers operate and the fundamentals of the HTTP protocol.
- Serve static files (HTML, CSS, JavaScript, images).
- Handle dynamic content using CGI scripts.
- Support for HTTP methods: GET, POST, and DELETE.
- Non-blocking I/O operations with
poll. - Customizable through configuration files.
- Serve content on multiple ports.
- Default error pages and customizable error handling.
- File upload support.
-
Clone the Repository:
git clone https://github.com/evan-ite/webserv.git cd webserv -
Install Dependencies:
Install C++ dependecies
sudo apt-get update sudo apt-get install g++ make build-essential
Check if python is installed, otherwise install
python3 --version sudo apt-get install python3
Check if python package installer is installed, otherwise install
pip3 --version sudo apt-get install python3-pip
Install python dependencies
pip install requests python-dotenv
-
42 Network API:
Rename temp.env
mv temp.env .env
To execute some of the CGI script you need acces to the 42 Network API: [https://api.intra.42.fr/apidoc]. Read the documentation to retrieve your Client ID and Secret, enter both in
.envin the root of this directory. Now you your API key will automatically be fetching when copmiling the project. -
Compile the Project:
make
Add your html and configuration to the content directory. To run the server with a configuration file:
./webserv path/to/configuration/fileIf no configuration file is provided, the server will use a default configuration defined in default/conf/default.conf.
Our example website is also available in content/ and can be launched with:
make runThe server's behavior is controlled by a configuration file, inspired by NGINX configuration files. For undefined settings the default settings from default.conf will be used. Below is a sample configuration:
server {
listen 80;
host localhost;
location / {
root content;
index html/index.html;
error_page 404 error/404.html;
}
location /cgi-bin {
allow GET POST;
}
location /upload {
root content;
allow GET POST DELETE;
autoindex on;
}
location /weather {
return 301 https://kanikeenkortebroekaan.nl/
}
}
listen: Port number to listen on.location: Defines how to handle requests to specific URL paths.root: The root directory for serving files.index: The default file to serve for directory requests.error_page: Custom error page locations.return: Redirect to internal or external pages.
- Urbano Bazzanella Filho
- Jan Strozyk
- Elise van Iterson