<!-- review: finished -->

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

# Keyval

Модуль позволяет использовать переменные со значениями из пар "ключ-значение",
которые содержатся в зоне разделяемой памяти, либо в хранилище Redis.

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

## Установка

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

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

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

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

Для работы с модулем необходимо загрузить его в контексте `main{}`:

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

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

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

```nginx
keyval_zone zone=one:32k;
keyval $arg_key $value zone=one;

server {
    listen 80;
    server_name  localhost;

    location /get {
        return 200 "key '$arg_key' has value = '$value'\\n";
    }

    location /set {
        set $value $arg_value;
        return 200 "'$arg_key' key added with '$arg_value' value\\n";
    }
}
```

Добавление и изменение записи в зоне разделяемой памяти 'one' производится при
присвоении значения переменной `$value`. При этом значение ключа
содержится в переменной `$arg_key`. В данной конфигурации это директива
`set`:

```nginx
set $value $arg_value;
```

<a id="demonstration-1"></a>

## Демонстрация работы

Определим несколько значений запросами:

```console
$ curl "localhost/set/?key=one&value=TextForKeyOne"

  'one' key added with 'TextForKeyOne' value
```

```console
$ curl "localhost/set/?key=two&value=TextForKeyTwo"

  'two' key added with 'TextForKeyTwo' value
```

Проверяем:

```console
$ curl "localhost/get/?key=one"

  key 'one' has value = 'TextForKeyOne'
```

```console
$ curl "localhost/get/?key=two"

  key 'two' has value = 'TextForKeyTwo'
```

<a id="using-redis"></a>

## Использование Redis

Модифицируем конфигурацию для хранения пар "ключ-значение" в хранилище Redis:

```nginx
keyval_zone_redis zone=oneredis;
keyval $arg_key $value zone=oneredis;

server {
    listen       80;
    server_name  localhost;

    location /get {
        return 200 "key '$arg_key' has value = '$value'\\n";
    }

    location /set {
        set $value $arg_value;
        return 200 "'$arg_key' key added with '$arg_value' value\\n";
    }
}
```

Добавим пару "ключ-значение" в хранилище Redis посредством запроса:

```console
$ curl "localhost/set/?key=one&value=TextForKeyOne"

  'one' key added with 'TextForKeyOne' value
```

То же самое средствами самого Redis:

```console
$ redis-cli

  127.0.0.1:6379> set oneredis:two 'text for key two'

  OK

  127.0.0.1:6379>
```

Проверяем:

```console
$ redis-cli --scan

  "oneredis:one"
  "oneredis:two"
```

```console
$ curl "localhost/get/?key=one"

  key 'one' has value = 'TextForKeyOne'
```

```console
$ curl "localhost/get/?key=two"

  key 'two' has value = 'text for key two'
```

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

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

Полное описание директив и исходный код доступны по ссылке:
[https://github.com/kjdev/nginx-keyval](https://github.com/kjdev/nginx-keyval).
