Перейти к содержимому

Изменения документа Установка SQL REST Proxy сервиса

Редактировал(а) PROSTO:СКУД 2026/09/16 13:37
От версии 1.1
отредактировано PROSTO:СКУД
на 2026/03/08 15:36
Изменить комментарий: К данной версии нет комментариев
К версии 10.2
отредактировано PROSTO:СКУД
на 2026/07/22 08:14
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Название
... ... @@ -1,1 +1,1 @@
1 -Установка RESTAPI SQL сервиса
1 +Установка SQL REST Proxy сервиса
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Main.AllDocs
1 +Main.WebHome
Содержимое
... ... @@ -1,42 +1,107 @@
1 -# SQL proxy service
2 -~#~# Для начала нужно скачать проект с github либо развернуть из архива
3 -```
4 -git clone https:~/~/prosto-skud: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@github.com/prosto-skud/p-skud-sql-proxy-service.git
5 -```
1 +== 1. Описание сервиса ==
6 6  
7 -~#~# Запуск
8 -~#~## Переходим в директорию сервиса
9 -```
10 -cd p-skud-sql-proxy-service
11 -```
3 +**SQL REST Proxy** — лёгкий REST-сервис на Python, разработанный как замена прямым вызовам SQL через ADODB.Connection в конфигурациях 1С, работающих на Linux. Поскольку COM-объекты и нативные ODBC-драйверы недоступны на Linux-платформе 1С:Предприятие, этот сервис позволяет выполнять произвольные SQL-запросы к внешним базам данных через стандартный HTTP-вызов из встроенного языка 1С.
12 12  
13 -~#~## Генерируем сертификаты
5 +**Поддерживаемые СУБД**
14 14  
15 -```
16 -bash generate_certs.sh
17 -```
7 +|=СУБД     |=Драйвер               |=Порт по умолчанию
8 +|PostgreSQL|psycopg2           |5432
9 +|Microsoft SQL Server|pymssql|1433
10 +|MySQL     |PyMySQL               |3306
18 18  
19 -~#~## Копируем .env
20 20  
21 -```
22 -cp .env.example .env
23 -```
24 24  
25 -~#~## И если требуется настраиваем под ваш контур .env
26 -```
27 -nano .env
28 -```
14 +**Режим развёртывания**
15 +Сервис запускается в Docker-контейнере и не требует установки каких-либо драйверов в хост-систему. Управление через docker-compose.
16 +
17 +**Безопасность**
18 +- Аутентификация по API-ключу (X-API-Key заголовок)
19 +- HTTPS/TLS с поддержкой собственного сертификата
20 +- Параметризованные запросы исключают SQL-инъекции
21 +
22 +**Мониторинг**
23 +Эндпоинт /metrics предоставляет метрики в формате Prometheus. Готовый конфиг prometheus.yml для сбора метрик включён в поставку. Эндпоинт /pools/stats возвращает детальную статистику по активным пулам соединений.
24 +
25 +
26 +== 2. Установка через docker контейнер ==
27 +
28 +
29 +Для установки нужно скачать проект с github либо развернуть из архива (p-skud-sql-proxy-service-main.zip находится в каталоге "Модули и ODBC-драйверы" из поставки расширения):
30 +
31 +># git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git
32 +
33 +**Запуск**
34 +Переходим в директорию сервиса
35 +
36 +># cd p-skud-sql-proxy-service
37 +
38 +Генерируем сертификаты
39 +
40 +># bash generate_certs.sh
41 +
42 +Копируем .env
43 +
44 +># cp .env.example .env
45 +
46 +И если требуется настраиваем под ваш контур .env
47 +
48 +># nano .env
49 +
29 29  В файле можно изменить:
30 -```
31 -# API Key для аутентификации запросов
32 -API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
33 33  
34 -# И порты работы Сервиса
35 -SERVICE_PORT=8443
36 -PROMETHEUS_PORT=9090
37 -```
52 +># API Key для аутентификации запросов
53 +># API_KEY=skud_proxy_19e1d5c545b55bdb3459281bd3a1c06a29c467c5645b3ceb748bb2589a5e0d46
38 38  
39 -~#~## Поднимаем все сервисы из docker-compose.yml
40 -```
41 -docker compose up -d
42 -```
55 +># И порты работы Сервиса
56 +># SERVICE_PORT=8443
57 +># PROMETHEUS_PORT=9090
58 +
59 +Поднимаем все сервисы из docker-compose.yml
60 +
61 +># docker compose up -d
62 +
63 +Проверка
64 +
65 +># curl -k https://<server>:8443/health
66 +
67 +== 3. Установка в виде сервиса ==
68 +
69 +Для установки нужно скачать проект с github либо развернуть из архива (p-skud-sql-proxy-service-main.zip находится в каталоге "Модули и ODBC-драйверы" из поставки расширения):
70 +
71 +># git clone https://prosto-skud:API_КЛЮЧ_ДЛЯ_ДОСТУПА_К_РЕПОЗИТОРИЮ@github.com/prosto-skud/p-skud-sql-proxy-service.git
72 +
73 +Для проекта нужен Python 3.11 или версия, с которой зависимости проекта гарантированно устанавливаются. Если в Astra Linux доступен только более старый Python, согласуйте установку Python 3.11 с администратором безопасности. Не заменяйте системный `/usr/bin/python3`.
74 +
75 +Минимальный набор пакетов для онлайн-установки зависимостей:
76 +
77 +># sudo apt update
78 +># sudo apt install -y \
79 +># python3 \
80 +># python3-venv \
81 +># python3-pip \
82 +># python3-dev \
83 +># build-essential \
84 +># gcc \
85 +># g++ \
86 +># openssl \
87 +># ca-certificates \
88 +># freetds-dev \
89 +># libpq-dev \
90 +># default-libmysqlclient-dev \
91 +># pkg-config
92 +
93 +Пояснение:
94 +
95 +- `freetds-dev` нужен для `pymssql`, который используется для MS SQL Server;
96 +- `libpq-dev` полезен для PostgreSQL-зависимостей;
97 +- `default-libmysqlclient-dev` и `pkg-config` могут понадобиться при сборке MySQL-зависимостей, хотя в проекте используется `PyMySQL`;
98 +- `openssl` нужен для генерации сертификатов;
99 +- `build-essential`, `gcc`, `g++`, `python3-dev` нужны, если какие-то wheels недоступны и зависимость собирается из исходников.
100 +
101 +Если какие-то из пакетов недоступны необходимо добавить добавить и расширенный репозиторий.
102 +Например для Astra Linux Special Edition 1.8 x86-64:
103 +># sudo nano /etc/apt/sources.list.d/astra.list
104 +Содержимое для stable-ветки:
105 +># deb https://dl.astralinux.ru/astra/stable/1.8_x86-64/main-repository/ 1.8_x86-64 main contrib non-free non-free-firmware
106 +># deb https://dl.astralinux.ru/astra/stable/1.8_x86-64/extended-repository/ 1.8_x86-64 main contrib non-free non-free-firmware
107 +