Compare commits

..

1 Commits

Author SHA1 Message Date
b489675003 feature: added default port forwarding logic and readme
Some checks failed
GIT.TSWF.IO/docker-base-images/nginx-routes/pipeline/head There was a failure building this commit
Gitea/docker-base-images/nginx-routes/pipeline/head This commit looks good
2023-09-08 11:31:39 +03:00
2 changed files with 46 additions and 19 deletions

46
README.MD Normal file
View File

@ -0,0 +1,46 @@
# Nginx Routes Helper
Специальный образ NGINX, который упрощает работу с проксированием портов между разными сетками у докер контейнеров.
По-умолчанию установлены утилиты для работы с роутами.
# Пре-стартовый скрипт
При старте контейнера происходит проверка на наличие скрипта, который должен быть выполнен в самом начале.
Скрипт располагается в `/invoke_initial_script.sh`, собственно сюда его и надо монтировать.
Например, требуется добавить роуты в контейнер при его старте.
`/invoke_initial_script.sh`:
```bash
#!/usr/bin/env bash
echo "Adding routes..."
ip route add 192.168.255.0/24 via 172.20.20.2
echo "Routes added!"
```
Тут может быть совершенно что угодно, этот скрипт выполнится до старта NGINX.
# Проброс портов по-умолчанию
Если пользователь не примонтирует свой `/etc/nginx/nginx.conf`, то по-умолчанию будет использоваться
обычный `stream` прокси с порта на адрес. Слушаемый порт и целевой адрес указываются через переменные окружения:
- `NGINX_PROXY_SOURCE_PORT` - Порт (например `80`), который слушает NGINX
- `NGINX_PROXY_TARGET_ADDRESS` - Адрес и порт (например `localhost:25565`), куда будет отправляться трафик
Пример использования в `docker-compose`:
```yml
version: '3.7'
services:
test-nginx:
image: "git.tswf.io/docker-base-images/nginx-routes:latest"
ports:
- "25565:25565"
environment:
NGINX_PROXY_SOURCE_PORT: 25565
NGINX_PROXY_TARGET_ADDRESS: "another_container:9000"
another_container:
image: "blablabla"
#...
```

View File

@ -1,19 +0,0 @@
events {}
stream {
server {
set $nginx_proxy_source_port '';
set $nginx_proxy_source_address '';
content_by_lua_block {
ngx.var.nginx_proxy_source_port = os.getenv("$NGINX_PROXY_SOURCE_PORT");
ngx.var.nginx_proxy_source_address = os.getenv("$NGINX_PROXY_SOURCE_ADDRESS");
ngx.say(ngx.var.nginx_proxy_source_port)
ngx.say(ngx.var.nginx_proxy_source_address)
}
listen $nginx_proxy_source_port;
proxy_pass $nginx_proxy_source_address;
}
}