Instructions for installing CShark software

Identification of the provisioned instance

1. Purpose of the document

The document establishes how to deploy the CShark software. The instructions allow the user to independently:

1. check the compliance of the computing environment with system requirements;
2. receive an identified delivery kit;
3. check its integrity;
4. perform automated installation;
5. obtain primary access credentials;
6. confirm the performance of the instance using control characteristics.

The instructions refer to the provided copy in the option demo for Ubuntu Server 24.04 LTS AMD64. After installation, a fictitious object Demo Parking “Northern” is automatically created without a real address and details of a legal entity: one level, two zones and 50 parking spaces. Standard Device Gateway, mock APS and other necessary emulators are included in the kit.

2. Identification of the delivery set

3. System requirements

4. Preliminary check of the stand

Run:

uname -m
grep -E '^(NAME|VERSION_ID)=' /etc/os-release
free -h
df -h /opt
timedatectl status

Expected signs:

uname -m: x86_64
VERSION_ID="24.04"
RAM: at least 8 GB
free space: at least 30 GB

5. Receipt of the delivery kit and installation

The delivery set - a signed archive, a public signature verification key and an installation program - is provided by the copyright holder upon request: LLC "KOMPETENTSIA", phone +7 495 532-61-18, address: 115280, Moscow, st. Leninskaya Sloboda, 21, building 1. Installation is performed from the received archive in the order of section 9. Basic installation command (from the catalog of the unpacked kit):

sudo ./install.sh --variant demo

The installer does not prompt for the public address interactively. If the parameter --public-host is not specified, the installer automatically selects the first server IPv4 address from the result hostname -I, excluding addresses 127.x.x.x. If the address could not be determined, the installation stops and prompts you to repeat the command with the parameter --public-host.

If the server has several network interfaces, explicitly specify the IP or DNS name by which the Web interface will be available to users:

sudo ./install.sh --variant demo --public-host 10.20.30.40

Instead of IP, you can pass a DNS name, for example --public-host cshark.example.ru. The value must be accessible from user workstations; it does not have to be an address published on the Internet.

Channel stable Only accepts signed kit. Flag --allow-unsigned-testing not used in standard installation. Parameter --variant demo chosen explicitly because the demo contains a fictitious 50-space parking lot. To install without demo data, use the same command with --variant clean; the set of emulators is preserved.

At runtime the installer:

1. checks the OS and AMD64 architecture;
2. checks SHA-256 before unpacking;
3. installs Docker Engine, Docker Compose v2 and system dependencies;
4. rechecks internal checksums;
5. downloads local Docker images without accessing an external registry;
6. generates unique instance secrets;
7. creates separate database roles;
8. applies migrations;
9. runs application services and observability tools;
10. uses a versioned demo seed 2026.07.2;
11. runs mock APS;
12. performs an automatic smoke test with mandatory location checks.

6. Criteria for successful installation

The installation is considered complete if the following conditions are simultaneously met:

• installer exited with code 0;
• message displayed INSTALLATION SUCCESSFUL;
• automatic smoke-test issued SMOKE TEST PASSED;
• file created /opt/cshark-stand/INITIAL-CREDENTIALS.txt;
• main profile containers have state running or healthy;
• The API returns a sign of readiness;
• The web interface opens from the user's workplace;
• smoke-test detects 50 parking spaces;
• mock APS has state running or healthy.

7. Gaining access

Show primary details:

sudo cat /opt/cshark-stand/INITIAL-CREDENTIALS.txt

Open in browser:

http://<HOST-IP-OR-DNS>:8088

Log in with your primary administrator account. File INITIAL-CREDENTIALS.txt contains the administrator password and Grafana details. Working file /opt/cshark-stand/.env contains generated service secrets and is created with limited access rights.

8. Performance monitoring

Check containers:

sudo docker compose \
  --env-file /opt/cshark-stand/.env \
  -f /opt/cshark-stand/compose.yml \
  --profile obs ps

Check the API:

curl -fsS http://127.0.0.1:8088/api/health

Check access from the user's workstation:

Web interface: http://<HOST-IP-OR-DNS>:8088
Grafana:       http://<HOST-IP-OR-DNS>:13000

In the Web interface, the login window, diagram, incidents, log, analytics, live status, equipment, scoreboard and administrative functions should be available in accordance with the rights of the logged in user.

9. Installation from the provided kit

Transfer the files provided by the copyright holder to the target server: selected signed archive: cshark-2.0.3-demo-ubuntu-24.04-amd64-offline.tar or cshark-2.0.3-clean-ubuntu-24.04-amd64-offline.tar, as well as a trusted public key to verify the signature.

Before unpacking, check the SHA-256 of the selected archive:

echo 'ccb36a121bf8e1b756f1190f9369e490585082417829458b9bc62108620850c6 cshark-2.0.3-demo-ubuntu-24.04-amd64-offline.tar' | sha256sum -c -
echo 'c6e008d2e97bc8421b6b5e66abca6c861b182f4f19f7e12b3e1dd0db9f80f26b cshark-2.0.3-clean-ubuntu-24.04-amd64-offline.tar' | sha256sum -c -

After successful verification, unpack the selected option:

mkdir -p /srv/cshark-install
tar -xf cshark-2.0.3-demo-ubuntu-24.04-amd64-offline.tar -C /srv/cshark-install
cd /srv/cshark-install/cshark-2.0.3-demo-ubuntu-24.04-amd64-offline
sudo ./install.sh \
  --public-host <HOST-IP-OR-DNS> \
  --trusted-public-key /path/cshark-release.public.pem

10. Diagnostics

Installation log:

sudo cat /opt/cshark-stand/install.log

Latest container logs:

sudo docker compose \
  --env-file /opt/cshark-stand/.env \
  -f /opt/cshark-stand/compose.yml \
  --profile obs logs --no-color --tail 200

If the installation is unsuccessful, the containers are stopped and the volumes are saved for diagnostic purposes. Re-installation over an existing directory is not performed until the cause is analyzed.

11. System stop

Stop an instance without deleting data:

sudo docker compose \
  --env-file /opt/cshark-stand/.env \
  -f /opt/cshark-stand/compose.yml \
  --profile obs down

12. Installation checklist

• Ubuntu Server 24.04 LTS OS and x86_64 architecture are confirmed.
• The amount of RAM and free disk space meets the requirements.
• The SHA-256 of the provided kit matches the instructions.
• The installer exited with the code 0.
• Smoke test passed.
• Primary details have been received.
• API /api/health answers.
• The web interface is accessible from the user's workstation.
• Demo parking “Northern” has been created, two zones and exactly 50 spaces.
• Mock APS is running and the change in location status is displayed in the system.
• Confirmed that there were no real frames before connecting the media package.
• Installation logs are saved if there are comments.