<!-- review: finished -->

<a id="external-cgi"></a>

# CGI

Модуль добавляет поддержку CGI.

Важно учитывать, что CGI **не** подходит для:

- высокого QPS;
- интенсивного трафика;
- высокой параллельности.

<a id="installation-6"></a>

## Установка

Для [установки](https://angie.software//angie/docs/installation/index.md#install-packages) модуля используйте один из
следующих пакетов:

- Angie: `angie-module-cgi`;
- Angie PRO: `angie-pro-module-cgi`.

<a id="loading-the-module-5"></a>

## Загрузка модуля

Подключение модуля в контексте `main{}`:

```nginx
load_module modules/ngx_http_cgi_module.so;
```

<a id="configuration-example-82"></a>

## Пример конфигурации

```nginx
server {
    listen 80;

    root /usr/share/angie/html;
    index index.html index.htm;

    location /cgi {
        alias /usr/share/angie/cgi-bin;
        cgi on;
    }
}
```

<a id="test-script"></a>

## Тестовый скрипт

Пример тестового исполняемого скрипта `test.sh`:

```bash
#!/bin/sh
echo "Content-Type: text/plain" # Добавить заголовок в ответе
echo "" # Разделитель заголовков и тела ответа

# Переменные окружения
echo "query string: $QUERY_STRING"
echo "server addr: $SERVER_ADDR"
echo "server port: $SERVER_PORT"

# Заголовки запроса через переменные окружения
echo "http host: $HTTP_HOST"
echo "http accept: $HTTP_ACCEPT"
echo "http Some-Field: $HTTP_SOME_FIELD"

body=$(cat) # Считывает тело запроса в переменную
echo "Request body: $body"
```

<a id="placing-the-script"></a>

## Размещение скрипта

Скрипт, в соответствии с конфигурацией, необходимо разместить в каталоге
`/usr/share/angie/cgi-bin/`.
Файл должен иметь права на чтение и выполнение.

<a id="example-of-request-execution"></a>

## Пример выполнения запроса

```console
$ curl  -H 'Some-Field:some text' -d '{"key1":"value1", "key2":"value2"}' -i \
  'http://127.0.0.1/cgi/hello.sh?a=valueA&b=valueB'

HTTP/1.1 200 OK
Server: Angie/|angie_version|
Date: |sampledatelong| 19:15:35 GMT
Transfer-Encoding: chunked
Connection: keep-alive
Content-Type: text/plain

query string: a=valueA&b=valueB
server addr: 127.0.0.1
server port: 80
http host: 127.0.0.1
http accept: */*
http Some-Field: some text
Request body: {"key1":"value1", "key2":"value2"}
```

<a id="additional-information-6"></a>

## Дополнительная информация

Подробная документация и исходный код доступны по ссылке:
[https://github.com/pjincz/nginx-cgi](https://github.com/pjincz/nginx-cgi)