Skip to content

Commit

Permalink
edited the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alash3al committed Dec 8, 2017
1 parent b34fda3 commit 3c1246c
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ HTTPSify <small>v3</small>
=============================
A `Let'sEncrypt` based reverse proxy, that will automatically generate &amp; renew valid `ssl` certs for your domains, it also enables the `http/2` protocol by default, and uses `roundrobin` as an algorithm to loadbalance the incoming requests between multiple `upstreams`

# Install
# Quick Start

### # Using Docker
> Just run the following and then have fun !!
Expand All @@ -16,7 +16,7 @@ $ docker run -v $HOME:/root/ -p 443:443 alash3al/httpsify
$ go get -u github.com/alash3al/httpsify
```

### Configurations
### # Configurations
> Goto your `$HOME` Directory and edit the `hosts.json` to something like this
```json
{
Expand All @@ -29,3 +29,28 @@ and yes, it can loadbalance the requests between multiple upstreams using `round

> Also You don't need to restart the server to reload the configurations, because `httpsify` automatically watches the
configurations file and reload it on any change.

# Author
Mohammed Al Ashaal, a `gopher` and problem solver, see more projects by me [here](https://github.com/alash3al).

# License
> The MIT License (MIT)
> Copyright (c) 2016 Mohammed Al Ashaal
> Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

> The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

0 comments on commit 3c1246c

Please sign in to comment.