Skip to content

Commit 7e9a0fb

Browse files
committed
Update README.md
1 parent a8d70ff commit 7e9a0fb

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1-
# httpsify
2-
a transparent HTTPS terminator for letsencrypt with auto certificates renewal and HTTP/2 new protocol
1+
# Intro
2+
a transparent HTTPS terminator for letsencrypt with auto certificates renewal, you may need to read more about LetsEncrypt from [here](https://letsencrypt.org/)
3+
4+
# Features
5+
* SSL Offloader .
6+
* HTTP/2 support .
7+
* Multi-Core support .
8+
* Auto-Renewal for generated certificates .
9+
* Blazing fast .
10+
* Very light .
11+
* Portable and small `~ 2 MB`
12+
* No system requirements .
13+
* No configurations required, just `httpsify --backend=http://127.0.0.1`
14+
* Passes `X-Forwarded-*` headers, `X-Real-IP` header and `X-Remote-IP`/`X-Remote-Port` to the backend server .
15+
16+
# Installation
17+
> Currently the only available binaries are built for `linux` `386/amd64` and you can download them from [here]() .
18+
> Building from source :
19+
-- MAke sure you have `Golang` installed .
20+
-- `go get github.com/alash3al/httpsify`.
21+
-- `go install github.com/alash3al/httpsify`.
22+
-- make sure that `$GOPATH/bin` in your `$PATH` .
23+
24+
# Quick Usage
25+
> lets say that you have extracted/built httpsify in the current working directory .
26+
```bash
27+
# this is the simplest way to run httpsify
28+
# this will run a httpsify instance listening on port 443 and passing the incoming requests to http://localhost
29+
# and building valid signed cerificates for the specified domains [they must be valid domain names]
30+
./httpsify --backend=http://localhost --domains="domain.tld,www.domain.tld,another.domain.tld"
31+
```
32+
33+
# Author
34+
I'm [Mohammed Al Ashaal](https://www.alash3al.xyz)

0 commit comments

Comments
 (0)