TARGControl Local — Установка и запуск

Эта инструкция поможет вам развернуть локальную версию системы TARGControl. В ней описаны системные требования, настройка конфигурационных файлов, запуск контейнеров и первые шаги в системе.

⚠️ Для запуска обязательно требуется установленный Docker и Docker Compose. Убедитесь, что установлены актуальные версии!

---

🖥️ Системные требования

Операционная система:

• Windows (10 и выше)
• Linux (рекомендуется Ubuntu 22.04 и выше)
• macOS

Минимальные аппаратные требования:

• 1 CPU
• 1 GB RAM
• 50+ GB свободного места на диске

Требуемое ПО:

• Docker
• Docker Compose

---

📂 Конфигурационные файлы

Для конфигруации сервиса используются:

• .env — переменные окружения
• docker-compose.yml — конфигурация приложения
• nginx.conf — настройки веб-сервера NGINX
• openapi-ru.yaml — документация по внешнему API на русском языке
• openapi-en.yaml — документация по внешнему API на английском языке

Параметры окружающей среды (.env)

Переменная	Значение по умолчанию	Назначение
TAG	latest	Версия TARGControl Local
APP_MEMORY	1024	Количество оперативной памяти, выделенно приложению в Мб
APP_URL	http://localhost:3000	URL адрес для доступа к веб сервису
S3_URL	http://s3:8000	URL адрес S3
S3_REGION	-	Регион, может быть пустым, если используется локальный S3
S3_ACCESS_KEY	ACCESS_KEY	Учётные данные для доступа к бакету
S3_SECRET_KEY	SECRET_KEY	Учётные данные для доступа к бакету
S3_BUCKET	s3-bucket	Наименование S3 бакета
TELEGRAM_ENABLED	false	Включение Telegram бота
TELEGRAM_USERNAME	-	Имя Telegram бота (Создается через BotFather)
TELEGRAM_TOKEN	-	Токен Telegram бота
POSTGRES_VERSION	17.3	Версия СУБД Postgres
POSTGRES_PORT	5432	Порт доступа к БД
POSTGRES_HOST	db	Хост доступа к бд
POSTGRES_USER	POSTGRES_USER	Пользователь доступа к БД
POSTGRES_PASSWORD	POSTGRES_USER	Пароль пользователя БД
API_FILE	openapi-ru.yaml	Файл документации внешнего API

🚀 Установка и запуск TARGControl Local на Windows

1. Подготовка

Склонируйте репозиторий через git clone или скопируйте файлы вручную .env, docker-compose.yml , nginx.conf, openapi-ru.yaml, openapi-en.yaml.

2. Запуск контейнеров

Запустите Docker Desktop и откройте окно терминала. В окне терминала перейдите в директорию с конфигурационными файлами с помощью команды

cd D:/путь/квашей/директории

Убедитесь, что порт 3000 свободен.

Выполните команду

docker compose up -d

Запуск может занять 1–3 минут, в зависимости от технических характеристик машины.

Начнётся процесс запуска docker-контейнеров

---

Установка и запуск TARGControl Local на Linux 🐧

Перед началом убедитесь что у вас установлен docker с помощью команды

sudo dpkg -l | grep docker

Примерный вывод:

1. Подготовка

Склонируйте репозиторий через git clone или скопируйте файлы вручную .env, docker-compose.yml , nginx.conf, openapi-ru.yaml, openapi-en.yaml.

2. Запуск контейнеров

Перейдите в директорию с конфигруационными файлами приложения и запустите его:

cd /path/to/targcontrol
sudo docker compose up -d

Если вы всё сделали правильно, вы увидите процесс запуска

🛠 Первоначальная настройка TARGControl Local

После запуска вам будет доступен веб-интерфейс приложения. По умолчанию используется 3000 порт. Перейдите в браузере на:

http://localhost:3000

При первом запуске откроется стартовая страница на которой необходимо заполнить данные оргfнизации:

• Название организации
• Временная зона организации
• Язык интерфейса организации
• Логин/пароль учётной записи администратора
• Логин/пароль учётной записи организации

⚠️ Важно: в локальной версии можно создать только одну организацию!

---

В качестве логина используется электронная почта

👤 Личный кабинет

После заполнения всех необходимых данных вас перебросит на страницу авторизации

Учётная запись администратора

Учётная запись администратора необходима для создания учётных записей пользователей и редактирования настроек организиции. Возможности администратора:

• Настройки организации и быстрое добавление учетных записей
• Настройки SMTP сервера

1. Для создания учётной записи пользователя, нажмите на иконку создания учётной записи и задайте логин и пароль
2. Для редактирования настроек организации нажмите на иконку в виде карандаша и выставьте необходимые настройки

---

Учётная запись организации

Возможности организации:

• Учёт рабочего времени
• Привязка сотрудников и устройств
• Просмотр сводной статистики

Учётная запись организации - учётная запись непосредственно для работы с системой TARGControl Local. После ввода логина и пароля откроется стартовая страница - Сводка организации, на которой отображается краткая информация по учёту рабочего времени сотрудников. При первом входе она будет выглядеть пустой т.к. не занесено ни одного сотрудника

Если же вы внесёте хотя бы одного сотрудника, по организации сразу посчитается статистика

---

📚 Документация

База знаний TARGControl Local

Подробнее о работе с системой можно ознакомиться в базе знание

Внешний API

Включает в себя API для учета рабочего времени и доступа сотрудников. Подробнее о моделях запросов и их содержании можно узнать перейдя:

http://localhost:3000/swagger