Skip to content

Commit dde7f40

Browse files
committed
some supplements in install.md
1 parent f7ce616 commit dde7f40

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

doc/INSTALL.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,28 @@
22

33
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.
44

5+
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.
6+
57
If you don't have a ADS-B receiver you can use the [Opensky-Network](https://opensky-network.org/). Create an account there first.
68

79
0. Install docker and docker compose (at least version 2) from [here](https://docs.docker.com/desktop/install/ubuntu/) and make it run (do the tutorial if necessary). Use [this](https://docs.docker.com/engine/install/debian/#install-using-the-convenience-script) tutorial for installing docker on a Raspberry Pi. Check the version of docker compose with `docker compose version` (needs to be >=2)
810

9-
1. Download the Beluga Project from [GitHub](https://github.com/amnesica/BelugaProject) as ZIP and extract it
11+
1. If you have installed BelugaProject before, backup your `.env` file before proceeding.
12+
2. Download the Beluga Project from [GitHub](https://github.com/amnesica/BelugaProject) as ZIP and extract it
1013

1114
```
1215
$ wget https://github.com/amnesica/BelugaProject/archive/refs/heads/master.zip -O BelugaProject.zip
1316
$ unzip BelugaProject.zip
1417
```
1518

16-
2. 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.
19+
3. 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.
1720

1821
```
1922
$ cp .env.template .env
2023
$ nano .env
2124
```
22-
25+
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.
26+
2327
For further information on how to configure the `.env` file expand the following section
2428
<details>
2529
<summary>Click to expand</summary>
@@ -28,7 +32,7 @@ If you don't have a ADS-B receiver you can use the [Opensky-Network](https://ope
2832

2933
To configure the file use following instructions to replace the `TODO`s.
3034

31-
When configuring multiple feeders the order of the entries in the following instructions are important. The first entries in `ipFeeder`, `typeFeeder`, `nameFeeder` and `colorFeeder` belong to the same feeder as well as the second and so on.
35+
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.
3236

3337
***
3438

@@ -92,7 +96,7 @@ If you don't have a ADS-B receiver you can use the [Opensky-Network](https://ope
9296
9397
</details>
9498
95-
3. Build the docker images and execute the containers (frontend, server, database) in the base path of Beluga Project. Note: If you installed docker only for root user, you need to execute the command below with `sudo` privilege
99+
4. 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
96100
97101
```
98102
$ ./run.sh install
@@ -114,4 +118,11 @@ If you don't have a ADS-B receiver you can use the [Opensky-Network](https://ope
114118
115119
You can ignore the error if you don't have a flightroute.csv file.
116120
117-
4. 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)
121+
5. 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).
122+
6. Operation and Maintenance
123+
124+
Executing
125+
```
126+
$ ./run.sh
127+
```
128+
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.

0 commit comments

Comments
 (0)