https://github.com/yankeguo/quickauth
A simple authentication reverse proxy with basic web interface
https://github.com/yankeguo/quickauth
authentication reverse-proxy
Last synced: about 1 month ago
JSON representation
A simple authentication reverse proxy with basic web interface
- Host: GitHub
- URL: https://github.com/yankeguo/quickauth
- Owner: yankeguo
- License: mit
- Created: 2024-07-25T10:46:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-16T06:36:34.000Z (almost 2 years ago)
- Last Synced: 2025-01-27T05:41:44.866Z (over 1 year ago)
- Topics: authentication, reverse-proxy
- Language: Go
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# quickauth
A basic reverse proxy featuring a simple authentication web interface
[中文文档](README.zh.md)
## Installation
- Build from source
```bash
git clone https://github.com/yankeguo/quickauth.git
cd quickauth
go build -o quickauth
```
- Download from GitHub
View for the latest release.
- Docker
```bash
docker run -d -p 80:80 -e QUICKAUTH_TARGET=example.com yankeguo/quickauth
```
## Environment Variables
- `QUICKAUTH_LISTEN`: The listening address to listen on. Default is `:80` (`:443` when TLS is enabled).
- `QUICKAUTH_TARGET`: The target address to proxy to.
- `QUICKAUTH_TARGET_INSECURE`: Whether to ignore the certificate verification of the target. Default is `false`.
- `QUICKAUTH_USERNAME`: The username for authentication.
- `QUICKAUTH_PASSWORD`: The password for authentication.
- `QUICKAUTH_SECRET_KEY`: The secret key for cookie signing.
- `QUICKAUTH_TITLE`: The title of the web page. Default is `Protected By QuickAuth`.
- `QUICKAUTH_TLS_CERT`: Path to the TLS certificate file. When set alongside `QUICKAUTH_TLS_KEY`, the server listens on HTTPS.
- `QUICKAUTH_TLS_KEY`: Path to the TLS private key file.
## Metics
```
GET /__quickauth/metrics
```
- `quickauth_proxy_http_requests_total`: The total number of requests.
- `quickauth_proxy_http_requests_duration`: The duration of requests.
## Ready
```
GET /__quickauth/ready
```
## Credits
GUO YANKE, MIT License