nginx配置文件使用环境变量的操作方法
导读
前言
Nginx是一款面向性能设计的HTTP服务器,相较于Apache、lighttpd具有占有内存少,稳定性高等优势。
由于现在需要部署nginx的docker,希望nginx配置文件里面有关server_name在启动容器前动态修改。
但是由于nginx的配置文件不支持使用环境变量。网上找了好些方案,最终选择使用envsubst
的方式改写nginx配置文件。
工作原理
Nginx由内核和模块组成,其中,内核的设计非常微小和简洁,完成的工作也非常简单,仅仅通过查找配置文件将客户端请求映射到一个location block(location是Nginx配置中的一个指令,用于URL匹配),而在这个location中所配置的每个指令将会启动不同的模块去完成相应的工作。
Nginx的模块从结构上分为核心模块、基础模块和第三方模块:
核心模块:HTTP模块、EVENT模块和MAIL模块
基础模块:HTTP Access模块、HTTP FastCGI模块、HTTP Proxy模块和HTTP Rewrite模块,
第三方模块:HTTP Upstream Request Hash模块、Notice模块和HTTP Access Key模块。
学习envsubst
envsubst就是将环境变量替换文件里面指定标记的值。
例如有如下文件env.conf
,内容如下
[test] ip = ${ip} port = ${port} url = http://${ip}:${port}/index.html phone = ${phone}
当执行export ip=192.168.1.5
,export port=8081
,export phone=13522223334
写入环境变量。
然后执行envsubst < env.conf > env.new.conf
,就可以生成如下的env.new.conf
[test] ip = 192.168.1.5 port = 8081 url = http://192.168.1.5:8081/index.html phone = 13522223334
还可以指定只替换部分环境变量,source env.env && envsubst '$ip;$phone' < env.conf
,这样只会替换ip和phone这两个变量。
上面只替换部分环境变量,在Linux测试只能用单引号,用双引号无效,分隔符试过, . ; |
这四种都可以,我估计还有更多分隔符。
应用nginx配置文件
docker-compose.yml
文件如下
version: "3" services: nginx: image: nginx:1.20.1-alpine container_name: nginx ports: - 80:80 - 443:443 environment: - NGINX_HOST=www.janbar.com - NGINX_PORT=80 volumes: - /root/janbar.temp:/etc/nginx/conf.d/janbar.temp command: /bin/sh -c "envsubst < /etc/nginx/conf.d/janbar.temp > /etc/nginx/conf.d/default.conf && exec nginx -g 'daemon off;'" network_mode: bridge restart: always
/root/janbar.temp
文件内容如下
server { listen ${NGINX_PORT}; listen [::]:${NGINX_PORT}; server_name ${NGINX_HOST}; location / { root /usr/share/nginx/html; index index.html index.htm; } error_page 500 502 503 504 /50x.html; location = /50x.html { root /usr/share/nginx/html; } }
按照上述docker-compose.yml
配置文件最终生成docker容器里面的配置文件如下cat /etc/nginx/conf.d/default.conf
server { listen 80; listen [::]:80; server_name www.janbar.com; location / { root /usr/share/nginx/html; index index.html index.htm; } error_page 500 502 503 504 /50x.html; location = /50x.html { root /usr/share/nginx/html; } }
总结
经过上述骚操作,最终可以通过环境变量的方式更新nginx的docker容器内部配置文件。大功告成!