Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tinfoil-knight/gargoyle
HTTP Web Server w/ Reverse Proxy & File Server
https://github.com/tinfoil-knight/gargoyle
fileserver go http reverse-proxy
Last synced: 28 days ago
JSON representation
HTTP Web Server w/ Reverse Proxy & File Server
- Host: GitHub
- URL: https://github.com/tinfoil-knight/gargoyle
- Owner: tinfoil-knight
- License: mit
- Created: 2022-07-22T19:11:51.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-16T18:58:45.000Z (about 2 years ago)
- Last Synced: 2024-08-03T23:28:57.179Z (4 months ago)
- Topics: fileserver, go, http, reverse-proxy
- Language: Go
- Homepage:
- Size: 56.6 KB
- Stars: 13
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-golang-repositories - gargoyle
README
# gargoyle
HTTP Web Server
## Features
- Reverse Proxying
- Load Balancing
- Active Healthchecks
- File Server
- Browsing Directories
- Serving Static Sites
- HTTP Response Header Modification
- Authentication
- Basic HTTP Auth
- Key Auth
- Optional TLS Support
- URL Rewrites
## Getting Started
**Pre-requisites**
- [Go >= 1.18](https://go.dev/)
- [GNU Make](https://www.gnu.org/software/make/)
### Configuration
- See [CONFIG.md](./CONFIG.md)
### Build from Source
After cloning the repo, run
```shell
make build
```
This will create a binary in the `bin` directory.
### Usage
```shell
./gargoyle
```
Default config file path: `./config.json`
## Author
- Kunal Kundu - [@tinfoil-knight](https://github.com/tinfoil-knight)
## License
Distributed under the MIT License. See [LICENSE](./LICENSE) for more information.
## Acknowledgements
- Blog Posts & Documentation from
- [Caddy](https://caddyserver.com/)
- [Nginx](https://www.nginx.com/)
- Learning Centers
- [Cloudflare](https://www.cloudflare.com/en-in/learning/)
- [Kong](https://konghq.com/learning-center)
- Talk on "Building a proxy server in Golang" by [@mauricio](https://github.com/mauricio)