Nyangate/README.md
2023-06-14 11:22:29 +02:00

57 lines
817 B
Markdown

# Nyangate
NYANET reverse proxy for HTTP
## Features
- [ ] configurable routing
- [ ] load balancing
- [ ] access control
- [ ] integration with IPMeow IPAM
- [ ] header stripping and rewriting
- [ ] intrusion detection
- [ ] rate limiting
- [ ] CLI interface
- [ ] REST API
## Building
Building with Docker
```bash
docker build . --tag nyangate
```
Local compilation
```bash
dotnet build
```
## Running
To run with Docker
```bash
docker run -it nyanet/nyangate
```
or docker-compose
```yaml
version: '3.3'
services:
nyangate:
ports:
- '80:80'
- '443:443'
volumes:
- './data:/srv/nyangate/config'
- './certs:/etc/tls/certs:ro'
restart: always
image: nyanet/nyangate
```
```bash
docker-compose up -d
```