Установка AppSec.Track¶
Прежде чем приступить к установке, скачайте и скопируйте zip-архив дистрибутива на сервер.
-
Скачайте архив с дистрибутивом из репозитория docker.swordfishsecurity.com.
curl -u user:password https://docker.swordfishsecurity.com/repository/appsec.track-maven-release/appsec-track/track-compose/3.13.0/track-compose-3.13.0-regular.zip -o /tmp/appsec-track.zip
-
Скопируйте архив дистрибутива на сервер.
scp /tmp/appsec-track.zip <your-user>@<your-server>:/tmp/appsec-track.zip
-
Зайдите на сервер.
ssh <your-user>@<your-server>
-
Создайте директорию для установки AppSec.Track (рекомендуется — /opt/appsec-track/) и переместите в неё дистрибутив.
sudo mkdir /opt/appsec-track && mv /tmp/appsec-track.zip /opt/appsec-track/appsec-track.zip
-
Перейдите в директорию AppSec.Track.
cd /opt/appsec-track
-
Распакуйте архив в созданную директорию.
sudo unzip appsec-track.zip
-
Выполните скрипт подготовки окружения.
sudo chmod +x ./install/install.sh sudo ./install/install.sh
-
Загрузите образы в Docker.
Авторизуйтесь в репозитории docker.swordfishsecurity.com.
sudo docker login docker.swordfishsecurity.com -u <user-name>
Примечание
<user-name>
— имя пользователя.Примечание
В данном случае загрузка образов не требуется — они будут автоматически загружены на заключительном этапе установки.
Загрузите образы.
sudo docker load --input /home/<user-name>/track-backend-<version_number>.tar sudo docker load --input /home/<user-name>/track-frontend-<version_number>.tar sudo docker load --input /home/<user-name>/track-db-<version_number>.tar sudo docker load --input /home/<user-name>/track-redis-<version_number>.tar sudo docker load --input /home/<user-name>/track-scanner-<version_number>.tar
Примечание
<user-name>
— имя пользователя;
<version_number>
— номер релиза, например 1.2. -
Для проверки результатов предыдущих шагов выполните следующую команду:
sudo docker images
Необходимо убедиться, что в списке Docker-контейнеров присутствуют track-backend, track-frontend, track-db, track-redis и track-scanner, а также проверить версию каждого контейнера.
REPOSITIRY TAG docker.swordfishsecurity.com/appsec-track/track-backend:<version_number> docker.swordfishsecurity.com/appsec-track/track-frontend:<version_number> docker.swordfishsecurity.com/appsec-track/track-db:<version_number> docker.swordfishsecurity.com/appsec-track/track-redis:<version_number> docker.swordfishsecurity.com/appsec-track/track-scanner:<version_number>
-
В случае необходимости переопределения портов или других настроек отредактируйте файл переменных окружения .env, содержащий в том числе пароли по умолчанию и версии используемых серверной и клиентской частей, а также базы данных AppSec.Track и конфигурационный файл docker-compose.yml.
Редактирование файла .env
Для отображения файлов, имена которых начинаются точкой, например .env, рекомендуется использовать команду:
ls -la
Для редактирования можно воспользоваться редактором nano:
sudo nano .env
Рекомендуется сгенерировать надежные пароли для подключения к базе данных и отредактировать файл переменных окружения .env
Также необходимо задать актуальные значения параметрам feed_url и base_url, определяющим URL-адреса Track.Feed и базы данных.
.env# Host/port for PostgreSQL instance pgsql_url=appsec-track-db pgsql_port=5432 # Password for postgres user pgsql_admin_password=sample_postgres_password_1337 # Track DB/User pgsql_db=trackdb pgsql_user=trackadm pgsql_password=track-password # Maximum number of simultaneous connections to DB pgsql_thread_count=32 # Images backend_image=docker.swordfishsecurity.com/appsec-track/track-backend:<version_number> frontend_image=docker.swordfishsecurity.com/appsec-track/track-frontend:<version_number> db_image=docker.swordfishsecurity.com/appsec-track/track-db:<version_number> redis_image=docker.swordfishsecurity.com/appsec-track/track-redis:<version_number> scanner_image=docker.swordfishsecurity.com/appsec-track/track-scanner:<version_number> # Feed and Base URL's feed_url=https://feed.appsec.global/ base_url=http://localhost:8080 # Redis Host/Port redis_host=appsec-track-redis redis_port=6379 # KeyStore ldap_store_pass=ldappass pksc_store_pass=pkscpass jks_store_pass=jkspass # Token lifetime token_max_age=3600
Также существует возможность отредактировать настройки Nginx в файле ./nginx/default.conf.
-
Запустите подготовку БД.
sudo docker-compose run --rm -v "$(pwd)/install/init_db.sh":/docker-entrypoint-initdb.d/init_db.sh appsec-track-db
-
Запустите контейнеры AppSec.Track.
sudo docker-compose up -d
При настройках по умолчанию система стартует на портах 8070 (frontend) и 8080 (backend).
-
Перейдите в пользовательский интерфейс AppSec.Track по адресу хоста (например,
http://<AppSec.Track_IP_address>:8070/
).Логин пользователя системы по умолчанию: admin@localhost, пароль: admin. Процедура смены пароля описана в Руководстве пользователя в разделе «Изменение пароля пользователя».
Войти в систему могут пользователи AppSec.Track или LDAP-пользователи. Работа LDAP-пользователей в системе описана в разделе «LDAP».