Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,43 +17,39 @@ This project is a basic HTTP server written in C++98. The standards listed below

# Table of Contents

- [Linux installation](#linux-installation)
- [Requirements](#requirements)
- [Compilation](#compilation)
- [Getting started](#getting-started)
- [Usage](#usage)
- [Flags](#flags)
- [Configuration](#configuration)
- [Contexts](#contexts)
- [Directives](#directives)
- [Example](#example)
- [Contributors](#contributors)

# Linux installation
# Getting started

## Requirements

[Docker](https://docs.docker.com/engine/install/) or
## Docker

```
apt install make
docker pull pythongermany/webserv
```
Pull the [docker image](https://hub.docker.com/repository/docker/pythongermany/webserv/general)

```
apt install clang
make docker.build
make docker.run
```

## Compilation

### Native
This will build and run the standalone webserver image

```
make [performance|debug|fsanitize]
make -C docker up
```
This will create a mariadb docker container for the database another container which will setup wordpress, compile webserv execute it. To populate the container env credentials you can make a copy of the [.env-example](docker/.env-example) file and rename it to `.env`, make sure to change the default values according to your needs.

### Docker
## Compile with make and clang

This will create a mariadb docker container for the database another container which will setup wordpress, compile webserv execute it. To populate the container env credentials you can make a copy of the [.env-example](docker/.env-example) file and rename it to `.env`, make sure to change the default values according to your needs.
```
make -C docker up
make [performance|debug|fsanitize]
```

# Usage
Expand Down Expand Up @@ -369,3 +365,8 @@ server {
```
./webserv [-i]
```

# Contributors

[jharrach](https://github.com/jharrach)
[PythonGermany](https://github.com/PythonGermany)