NGINX
Для работы серверных компонентов Indeed CM на ОС Linux настройте веб-сервер nginx в качестве обратного прокси-сервера:
- Установите nginx.
- Установите SSL/TLS-сертификат.
- Настройте конфигурационный файл nginx.conf.
Выберите инструкцию в зависимости от ОС рабочей станции, где вы устанавливаете nginx.
- Debian-based
- RHEL-based
Установка nginx
Установите пакеты, необходимые для подключения apt-репозитория.
Ubuntusudo apt install curl gnupg2 ca-certificates lsb-release ubuntu-keyringDebiansudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyringИмпортируйте официальный ключ, используемый apt для проверки подлинности пакетов.
curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/nullПодключите apt-репозиторий.
echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" | sudo tee /etc/apt/sources.list.d/nginx.listУстановите nginx.
sudo apt update
sudo apt install nginx
Документация по установке на другие ОС доступна на сайте NGINX.
Установка SSL/TLS-сертификата
Как создать SSL/TLS-сертификат
Чтобы установить SSL/TLS-сертификат на веб-сервер:
- Скопируйте файлы сертификата и ключа в папку, которая указана в файле конфигурации nginx.
sudo cp ./SSL.crt /etc/ssl/certs/
sudo cp ./SSL.key /etc/ssl/private/ - Добавьте сертификат корневого УЦ в доверенные на рабочей станции с установленным nginx.
sudo cp ./ca.crt /usr/local/share/ca-certificates/
sudo update-ca-certificates -f - Сделайте сертификат доверенным в домене, например, с помощью групповых политик.
- Выдайте учетной записи www-data права на чтение файлов сертификата.
Настройка конфигурационного файла
Для работы Indeed CM настройте nginx, чтобы веб-сервер обслуживал запросы и отправлял их на проксируемый адрес – сервис Indeed CM.
Работа nginx и его модулей определяется в конфигурационном файле nginx.conf. В зависимости от операционной системы nginx.conf находится в каталоге /usr/local/nginx/conf, /etc/nginx или /usr/local/etc/nginx.
Таблица рекомендуемых к использованию директив
| Контекст | Директива | Значение по умолчанию | Рекомендуемое значение | Комментарий |
|---|---|---|---|---|
http | proxy_buffer_size | 4k|8k | 16k | Увеличивается размер прокси буферов для передачи информации в http-запросах. |
proxy_buffers | 8 4k|8 8k | 4 16k | Увеличивается размер прокси буферов для передачи информации в http-запросах. | |
types_hash_max_size | 1024 | 4096 | Увеличивается размер хэш-таблиц для хранения информации из-за большого количества проксируемых сервисов. | |
client_max_body_size | 1m | 10m | Увеличивается допустимый размер загружаемых в систему файлов. | |
large_client_header_buffers | 4 8k | 4 16k | Увеличивается допустимый размер буферов для чтения больших заголовков запроса клиента. Например, длинные URL или файлы cookie. | |
server | listen | 80 | 443 ssl | Измените порт прослушивания на протокол HTTPS, по умолчанию nginx настроен на HTTP. |
3003 ssl | Укажите порт 3003 для дополнительного контекста server, если Indeed CM настроен на работу с клиентскими агентами. | |||
ssl_certificate | — | /etc/ssl/private/SSL.crt | Для работы по HTTPS укажите путь к файлу с цепочкой сертификатов (SSL сертификат, сертификаты промежуточного и корневого УЦ). | |
ssl_certificate_key | — | /etc/ssl/private/SSL.key | Для работы по HTTPS укажите путь к закрытому ключу SSL сертификата. | |
ssl_verify_client | off | optional_no_ca | Добавьте в случае авторизации по сертификату (используется клиентскими агентами) | |
location | proxy_pass | — | * | Один экземпляр контекста location направляет запросы на один адрес — сервис Indeed CM. Таким образом, количество контекстов location должно быть равно количеству сервисов Indeed CM.Точка проксирования указывается в формате: http://localhost:*PORT*/cm/*SERVICENAME*http://localhost:*PORT*/*AGENTSERVICENAME*Где PORT — порт, на котором запущен сервис Indeed CM, SERVICENAME и AGENTSERVICENAME — имя запущенного сервиса. |
include | — | /etc/nginx/conf.d/proxy.conf | Некоторые директивы описываются для каждого location. Для компактности конфигурационного файла рекомендуется создать файл с часто используемым набором директив и подключать его в каждый location вместо описывания набора целиком. | |
proxy_http_version | 1.0 | 1.1 | Версия 1.1 рекомендуется для keepalive-подключений и NTLM-аутентификации. | |
proxy_cache_bypass | — | $http_upgrade | Определяет условия, при которых ответ не берется из кэша. | |
proxy_set_header | — | Upgrade $http_upgrade | Определяет переход с HTTP/1.1 на веб-сокет после установки соединения. | |
Connection keep-alive | Для использования keepalive-подключений. | |||
Host $host | Для сохранения в заголовках имени сервера nginx при их передаче сервисам Indeed CM. | |||
X-Real-IP $remote_addr | По умолчанию работа в режиме обратного прокси использует нестандартные заголовки о пользовательском IP адресе, что требует задания данной директивы. | |||
X-Forwarded-For $proxy_add_x_forwarded_for | Определяет формирование заголовка для корректного проксирования. Если в изначальном заголовке нет поля X-Forwarded-For, то $proxy_add_x_forwarded_for = $remote_addr. | |||
X-Forwarded-Proto $scheme | Веб-сервер принимает запросы по HTTPS и проксирует их к HTTP-сервисам Indeed CM для корректной подмены протокола. | |||
fastcgi_buffers | 8 4k|8k | 16 16k | Определяет количество и размер буферов для чтения ответов от FastCGI-сервера на одно подключение. | |
fastcgi_buffer_size | 4k|8k | 32k | Определяет размер буфера для чтения первой части ответа от FastCGI-сервера. | |
proxy_set_header | — | x-ssl-client-cert $ssl_client_escaped_cert | Директива передавать клиентский сертификат при проксировании. Используется клиентскими агентами для авторизации по сертификату. |
Из-за многократного описания контекстов location определенный набор директив повторяется. Для удобства конфигурации вынесите этот набор директив в отдельный файл и включите директивы из этого файла в описание контекста (директива include).
Создайте файл с многократно используемыми директивами. Можно разместить такой файл с расширением CONF в каталоге /etc/nginx/conf.d/.
Рекомендуемое содержимое файла proxy.conf для работы с Indeed CMproxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection keep-alive;
proxy_set_header Host $host;
proxy_cache_bypass $http_upgrade;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
fastcgi_buffers 16 16k;
fastcgi_buffer_size 32k;Сконфигурируйте основной файл конфигурации nginx. Убедитесь, что имена контекстов
locationсовпадают с путем к проксируемому сервису.Пример файла nginx.conf для работы с Indeed CM
user www-data;
worker_processes auto;
error_log /var/log/nginx/error.log notice;
events { worker_connections 1024; }
http {
proxy_buffer_size 64k;
proxy_buffers 4 64k;
types_hash_max_size 4096;
add_header X-Frame-Options sameorigin always;
add_header X-Content-Type-Options nosniff;
large_client_header_buffers 4 16k;
log_format main '[$time_local] $remote_addr VIA $scheme --- $status --- $request \n $ssl_client_fingerprint';
access_log /var/log/nginx/access.log main;
sendfile on;
tcp_nopush on;
include /etc/nginx/mime.types;
default_type application/octet-stream;
server {
listen 443 ssl;
server_name $hostname;
ssl_certificate "/etc/ssl/certs/SSL.crt";
ssl_certificate_key "/etc/ssl/private/SSL.key";
location /cm/mc
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5001/cm/mc; }
location /cm/ss
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5002/cm/ss; }
location /cm/rss
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5003/cm/rss; }
location /cm/api
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5004/cm/api; }
location /cm/credprovapi
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5005/cm/credprovapi; }
location /cm/oidc
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5008/cm/oidc; }
location /cm/wizard
{ proxy_pass http://localhost:5009; }
#location /api
#{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5010/api; }
}
server {
listen 3003 ssl;
server_name $hostname;
ssl_certificate "/etc/ssl/certs/SSL.crt";
ssl_certificate_key "/etc/ssl/private/SSL.key";
ssl_verify_client optional_no_ca;
location /agentregistrationapi
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5006/agentregistrationapi; }
location /agentserviceapi
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5007/agentserviceapi;
proxy_set_header x-ssl-client-cert $ssl_client_escaped_cert; }
}
}Чтобы применить изменения в конфигурационном файле, перезагрузите конфигурацию или перезапустите nginx.
sudo nginx -s reload
Установка nginx
Для установки nginx убедитесь, что на рабочей станции подключен и настроен репозиторий пакетов nginx. При необходимости добавьте репозиторий вручную.
Чтобы добавить репозиторий пакетов nginx вручную:
Установите пакеты для подключения yum-репозитория.
sudo yum install yum-utilsСоздайте файл /etc/yum.repos.d/nginx.repo со следующим содержимым:
[nginx-stable]
name=nginx stable repo
baseurl=http://nginx.org/packages/centos/$releasever/$basearch/
gpgcheck=1
enabled=1
gpgkey=https://nginx.org/keys/nginx_signing.key
module_hotfixes=true
[nginx-mainline]
name=nginx mainline repo
baseurl=http://nginx.org/packages/mainline/centos/$releasever/$basearch/
gpgcheck=1
enabled=0
gpgkey=https://nginx.org/keys/nginx_signing.key
module_hotfixes=trueУстановите nginx.
sudo yum install nginx
Если система запросит подтвердить GPG-ключ, проверьте, что отпечаток ключа совпадает с 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62, и подтвердите GPG-ключ.
Документация по установке на другие ОС доступна на портале NGINX.
Установка SSL/TLS-сертификата
Как создать SSL/TLS-сертификат
Чтобы установить SSL/TLS-сертификат на веб-сервер:
- Скопируйте файлы сертификата и ключа в папку, которая указана в файле конфигурации nginx.
sudo cp ./SSL.crt /etc/ssl/certs/
sudo cp ./SSL.key /etc/ssl/private/ - Добавьте сертификат корневого УЦ в доверенные на рабочей станции с установленным nginx.
sudo cp ./ca.crt /etc/pki/ca-trust/source/anchors/
sudo update-ca-trust extract - Сделайте сертификат доверенным в домене, например, с помощью групповых политик.
- Выдайте учетной записи nginx права на чтение файлов сертификата.
Настройка конфигурационного файла
Для работы Indeed CM настройте nginx, чтобы веб-сервер обслуживал запросы и отправлял их на проксируемый адрес – сервис Indeed CM.
Работа nginx и его модулей определяется в конфигурационном файле nginx.conf. В зависимости от операционной системы nginx.conf находится в каталоге /usr/local/nginx/conf, /etc/nginx или /usr/local/etc/nginx.
Таблица рекомендуемых к использованию директив
| Контекст | Директива | Значение по умолчанию | Рекомендуемое значение | Комментарий |
|---|---|---|---|---|
http | proxy_buffer_size | 4k|8k | 16k | Увеличивается размер прокси буферов для передачи информации в http-запросах. |
proxy_buffers | 8 4k|8 8k | 4 16k | Увеличивается размер прокси буферов для передачи информации в http-запросах. | |
types_hash_max_size | 1024 | 4096 | Увеличивается размер хэш-таблиц для хранения информации из-за большого количества проксируемых сервисов. | |
client_max_body_size | 1m | 10m | Увеличивается допустимый размер загружаемых в систему файлов. | |
large_client_header_buffers | 4 8k | 4 16k | Увеличивается допустимый размер буферов для чтения больших заголовков запроса клиента. Например, длинные URL или файлы cookie. | |
server | listen | 80 | 443 ssl | Измените порт прослушивания на протокол HTTPS, по умолчанию nginx настроен на HTTP. |
3003 ssl | Укажите порт 3003 для дополнительного контекста server, если Indeed CM настроен на работу с клиентскими агентами. | |||
ssl_certificate | — | /etc/ssl/private/SSL.crt | Для работы по HTTPS укажите путь к файлу с цепочкой сертификатов (SSL сертификат, сертификаты промежуточного и корневого УЦ). | |
ssl_certificate_key | — | /etc/ssl/private/SSL.key | Для работы по HTTPS укажите путь к закрытому ключу SSL сертификата. | |
ssl_verify_client | off | optional_no_ca | Добавьте в случае авторизации по сертификату (используется клиентскими агентами) | |
location | proxy_pass | — | * | Один экземпляр контекста location направляет запросы на один адрес — сервис Indeed CM. Таким образом, количество контекстов location должно быть равно количеству сервисов Indeed CM.Точка проксирования указывается в формате: http://localhost:*PORT*/cm/*SERVICENAME*http://localhost:*PORT*/*AGENTSERVICENAME*Где PORT — порт, на котором запущен сервис Indeed CM, SERVICENAME и AGENTSERVICENAME — имя запущенного сервиса. |
include | — | /etc/nginx/conf.d/proxy.conf | Некоторые директивы описываются для каждого location. Для компактности конфигурационного файла рекомендуется создать файл с часто используемым набором директив и подключать его в каждый location вместо описывания набора целиком. | |
proxy_http_version | 1.0 | 1.1 | Версия 1.1 рекомендуется для keepalive-подключений и NTLM-аутентификации. | |
proxy_cache_bypass | — | $http_upgrade | Определяет условия, при которых ответ не берется из кэша. | |
proxy_set_header | — | Upgrade $http_upgrade | Определяет переход с HTTP/1.1 на веб-сокет после установки соединения. | |
Connection keep-alive | Для использования keepalive-подключений. | |||
Host $host | Для сохранения в заголовках имени сервера nginx при их передаче сервисам Indeed CM. | |||
X-Real-IP $remote_addr | По умолчанию работа в режиме обратного прокси использует нестандартные заголовки о пользовательском IP адресе, что требует задания данной директивы. | |||
X-Forwarded-For $proxy_add_x_forwarded_for | Определяет формирование заголовка для корректного проксирования. Если в изначальном заголовке нет поля X-Forwarded-For, то $proxy_add_x_forwarded_for = $remote_addr. | |||
X-Forwarded-Proto $scheme | Веб-сервер принимает запросы по HTTPS и проксирует их к HTTP-сервисам Indeed CM для корректной подмены протокола. | |||
fastcgi_buffers | 8 4k|8k | 16 16k | Определяет количество и размер буферов для чтения ответов от FastCGI-сервера на одно подключение. | |
fastcgi_buffer_size | 4k|8k | 32k | Определяет размер буфера для чтения первой части ответа от FastCGI-сервера. | |
proxy_set_header | — | x-ssl-client-cert $ssl_client_escaped_cert | Директива передавать клиентский сертификат при проксировании. Используется клиентскими агентами для авторизации по сертификату. |
Из-за многократного описания контекстов location определенный набор директив повторяется. Для удобства конфигурации вынесите этот набор директив в отдельный файл и включите директивы из этого файла в описание контекста (директива include).
Создайте файл с многократно используемыми директивами. Можно разместить такой файл с расширением CONF в каталоге /etc/nginx/conf.d/.
Рекомендуемое содержимое файла proxy.conf для работы с Indeed CMproxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection keep-alive;
proxy_set_header Host $host;
proxy_cache_bypass $http_upgrade;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
fastcgi_buffers 16 16k;
fastcgi_buffer_size 32k;Сконфигурируйте основной файл конфигурации nginx. Убедитесь, что имена контекстов
locationсовпадают с путем к проксируемому сервису.Пример файла nginx.conf для работы с Indeed CM
user nginx;
worker_processes auto;
error_log /var/log/nginx/error.log notice;
events { worker_connections 1024; }
http {
proxy_buffer_size 64k;
proxy_buffers 4 64k;
types_hash_max_size 4096;
add_header X-Frame-Options sameorigin always;
add_header X-Content-Type-Options nosniff;
large_client_header_buffers 4 16k;
log_format main '[$time_local] $remote_addr VIA $scheme --- $status --- $request \n $ssl_client_fingerprint';
access_log /var/log/nginx/access.log main;
sendfile on;
tcp_nopush on;
include /etc/nginx/mime.types;
default_type application/octet-stream;
server {
listen 443 ssl;
server_name $hostname;
ssl_certificate "/etc/ssl/certs/SSL.crt";
ssl_certificate_key "/etc/ssl/private/SSL.key";
location /cm/mc
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5001/cm/mc; }
location /cm/ss
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5002/cm/ss; }
location /cm/rss
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5003/cm/rss; }
location /cm/api
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5004/cm/api; }
location /cm/credprovapi
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5005/cm/credprovapi; }
location /cm/oidc
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5008/cm/oidc; }
location /cm/wizard
{ proxy_pass http://localhost:5009; }
#location /api
#{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5010/api; }
}
server {
listen 3003 ssl;
server_name $hostname;
ssl_certificate "/etc/ssl/certs/SSL.crt";
ssl_certificate_key "/etc/ssl/private/SSL.key";
ssl_verify_client optional_no_ca;
location /agentregistrationapi
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5006/agentregistrationapi; }
location /agentserviceapi
{ include /etc/nginx/conf.d/proxy.conf; proxy_pass http://localhost:5007/agentserviceapi;
proxy_set_header x-ssl-client-cert $ssl_client_escaped_cert; }
}
}Чтобы применить изменения в конфигурационном файле, перезагрузите конфигурацию или перезапустите nginx.
sudo nginx -s reload