wzray/httb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme.md

Browse source
This commit is contained in:
Arthur Khachaturov 2024-07-26 00:50:52 +03:00
parent ec9455da53
commit b806096ee3
No known key found for this signature in database
GPG key ID: CAC2B7EB6DF45D55
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -6,7 +6,7 @@ HTTB allows you to create a basic HTTP server using only bash scripts and the `s
# 🛠️ Setup # 🛠️ Setup
These instructions will help you get started with HTTB! These instructions will help you get started with HTTB!
### 🐋 Docker ## 🐋 Docker
I would heavily recommend **not** running this on bare metal, as safety was (and still is) my last concern at the moment. This repository contains an example `Dockerfile` and `docker-compose.yml` files that can get you started. I would heavily recommend **not** running this on bare metal, as safety was (and still is) my last concern at the moment. This repository contains an example `Dockerfile` and `docker-compose.yml` files that can get you started.
To get started with Docker: To get started with Docker:
@ -22,23 +22,23 @@ To get started with Docker:
docker compose up --build docker compose up --build
``` ```
### 🖥️ Native ## 🖥️ Native
If you prefer to run HTTB natively on your system, ensure you have `bash` and `socat` installed. These tools are necessary for creating and managing TCP sockets. If you prefer to run HTTB natively on your system, ensure you have `bash socat file` installed. These tools are necessary for running this server.
### Debian/Linux Mint ### Debian/Linux Mint
To install `socat` on Debian-based systems: To install dependencies on Debian-based systems:
```bash ```bash
sudo apt-get install socat sudo apt-get install socat
``` ```
### Arch Linux ### Arch Linux
To install `socat` on Arch-based systems: To install dependencies on Arch-based systems:
```bash ```bash
sudo pacman -S socat sudo pacman -S socat
``` ```
### macOS ### macOS
To install `socat` on macOS using Homebrew: To install dependencies on macOS using Homebrew:
```bash ```bash
brew install socat brew install socat
``` ```
@ -83,7 +83,7 @@ server::post_form() {
http::run "$@" http::run "$@"
``` ```
# ⚡ Benchmarking # ⚡ Benchmarks
It's... bad 🥲 It's... bad 🥲
All benchmarks were conducted on an i7-1360P laptop with 16GB of RAM using the tool codesenberg/bombardier. The benchmark folder in the repository contains all the source files used for benchmarking, along with a run.sh script to automate the benchmarking process. Here are the detailed results: All benchmarks were conducted on an i7-1360P laptop with 16GB of RAM using the tool codesenberg/bombardier. The benchmark folder in the repository contains all the source files used for benchmarking, along with a run.sh script to automate the benchmarking process. Here are the detailed results: