Skip to content

Latest commit

 

History

History
128 lines (83 loc) · 6.42 KB

INSTALL.md

File metadata and controls

128 lines (83 loc) · 6.42 KB

Install (Docker version)

With this manual you can install the Beluga Project in a docker container on your system. Only docker is required on your machine. Everything else will be taken care of in the container. Run the following instructions on your productive system, e.g. a Raspberry Pi 4B or on your local machine if you just want to test the project. Instructions are mainly for Debian based systems.

For RaspberryPi 4B it is recommended to use a 64 bit OS version, because BelugaProject is running significantly faster than on 32 bit OS version.

If you don't have a ADS-B receiver you can use the Opensky-Network. Create an account there first.

  1. Install docker and docker compose (at least version 2) from here and make it run (do the tutorial if necessary). Use this tutorial for installing docker on a Raspberry Pi. Check the version of docker compose with docker compose version (needs to be >=2)

  2. If you have installed BelugaProject before, backup your .env file before proceeding.

  3. Download the Beluga Project from GitHub as ZIP and extract it

    $ wget https://github.com/amnesica/BelugaProject/archive/refs/heads/master.zip -O BelugaProject.zip
$ unzip BelugaProject.zip

  4. Rename the environment variables template file .env.template in .env and configure the environment variables in the .env file. You can use nano for editing the config file.

    $ cp .env.template .env
$ nano .env

    If you have a backup of your previous .env file (see above), you can copy the values from it now. Be aware that current template file .env.template may have been changed since last version.

    For further information on how to configure the .env file expand the following section

    Click to expand

    To be able to run the spring boot application you have to provide some information in the configuration file .env which is used when you run the application with docker.

    To configure the file use following instructions to replace the TODOs.

    When configuring multiple feeders the order of the entries in the following instructions is important. The first entries in ipFeeder, typeFeeder, nameFeeder and colorFeeder belong to the same feeder as well as the second and so on.

    Please note: If you miss to provide some information or forgot to replace some TODOs the application start may fail or some features will not work properly.

    When you have multiple entries seperated by a comma do not use blank spaces like "entry,␣entry".

    1. Set your feeder location. Replace the values with your antenna position coordinates. Later this will be the shown on the map with an antenna icon.

      latitudeLocation=54.1234
longitudeLocation=8.1234

    2. Enter the URLs of your feeders with an json output seperated by comma (If you do not have a local feeder, just leave the value empty)

    • for AirSquitter use the URL http://XXX.XXX.XXX.XX/aircraftlist.json

    • for tar1090 use the URL http://XXX.XXX.XXX.XX/tar1090/data/aircraft.json

    • for adsbx use the URL http://XXX.XXX.XXX.XX/adsbx/data/aircraft.json

    • for fr24feeder (dump1090) use the URL http://XXX.XXX.XXX.XX/dump1090/data/aircraft.json

    • for dump1090-fa use the URL http://XXX.XXX.XXX.XX/dump1090-fa/data/aircraft.json

      ipFeeder=URL1,URL2

    1. Enter the type of your feeders. Currently supported: adsbx, airsquitter, dump1090-fa, fr24feeder (If you do not have a local feeder, just leave the value empty)

      typeFeeder=typeoffeeder1,typeoffeeder2

    2. Enter the name of your feeders seperated by comma. Name should be not too long to fit well in control elements (If you do not have a local feeder, just leave the value empty)

      nameFeeder=Name1,Name2

    3. Enter the color of your feeders seperated by comma. This color is used later in statistical views (if you do not have a local feeder, set colorFeeder=red (valid color is needed here!)

      colorFeeder=red, blue

    4. Enter the amount of your feeders. This value must match with the amount of feeder configuration entries (If you do not have a local feeder set amountFeeder=1)

      amountFeeder=2

    5. Production URL for the frontend (PROD_BASE_URL_WEBAPP): Enter the URL of your productive systems ip address (for a simple test you can use localhost)

    6. Database password (SPRING_DATASOURCE_PASSWORD): Set password for the database belugaDb

    7. Opensky-Credentials: (Optional) Replace TODOs with your opensky network credentials. If you do not provide credentials this function will be disabled

    8. Search engine URL to search for aircraft pictures when planespotters.net does not find results (default is startpage): (Optional) Replace given URL with a new one. Important: <PLACEHOLDER> is required, because it will be replaced with registration or hex

  5. Build the docker images and execute the containers (frontend, server, database) in the base path of Beluga Project. Important: If you installed docker only for root user, you need to execute the command below with sudo privilege

    $ ./run.sh install

    Possible errors:

    The following error might appear after you run the command above:

    psql: error: FATAL: the database system is in recovery mode

    In this case try execute ./run.sh load-db.

    The following error might appear if you don't specify a flightroute.csv file:

    ERROR: missing data for column "flight_route"

    CONTEXT: COPY flightroute_data, line 2: ""SAMPLE,EDDH-EDDF,1257415993"")

    You can ignore the error if you don't have a flightroute.csv file.

  6. When Beluga Project is installed and is running go to <system-prod-ip>:8090 in your browser. If you just want to test the project, enable the Opensky-Network functionality in the settings menu (an Opensky-Network account is needed).

  7. Operation and Maintenance

    Executing

    $ ./run.sh

    will show some options for troubleshooting, operation and maintanance. Important: If you installed docker only for root user, you need to execute the command with sudo privilege.