Skip to content

Commit

Permalink
remove duplicated notes and remove docker run command entirely
Browse files Browse the repository at this point in the history
  • Loading branch information
fredclausen committed Oct 27, 2023
1 parent 7f1a975 commit 3a8885c
Showing 1 changed file with 2 additions and 34 deletions.
36 changes: 2 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,25 +26,7 @@ This container is designed to work in conjunction with a Mode-S / BEAST provider

---

## Quick Start with `docker run`

**NOTE**: The Docker command provided in this quick start is given as an example and parameters should be adjusted to suit your needs.

Launch the FlightAwareMap docker container with the following commands:

```shell
docker volume create flightairmap_db
docker volume create flightairmap_webapp
docker run -d \
--name=flightairmap \
-p 8080:80 \
-e BASESTATIONHOST=readsb \
-e TZ=Australia/Perth \
-e FAM_INSTALLPASSWORD="very_secure_password_12345" \
-v flightairmap_db:/var/lib/mysql \
-v flightairmap_webapp:/var/www/flightairmap \
ghcr.io/sdr-enthusiasts/docker-flightairmap:latest
```
## Container notes

On the first run of the container, the database will be created & populated and data will be downloaded from the internet. This process can take quite some time. On my system, around 30 minutes. Once the first run processes are finished, to access FlightAirMap, you can:

Expand Down Expand Up @@ -75,21 +57,14 @@ services:
ports:
- 8080:80
environment:
- TZ=Australia/Perth
- TZ=${FEEDER_TZ}
- BASESTATIONHOST=readsb
- FAM_INSTALLPASSWORD="very_secure_password_12345"
volumes:
- fam_db:/var/lib/mysql
- fam_webapp:/var/www/flightairmap
```
On the first run of the container, the database will be created & populated and data will be downloaded from the internet. This process can take quite some time. On my system, around 30 minutes. Once the first run processes are finished, to access FlightAirMap, you can:
- Browse to `http://dockerhost:8080/` to access the FlightAirMap GUI.
- Browse to `http://dockerhost:8080/install/` to access the FlightAirMap settings area.

With regards to settings - where one exists, you should use an environment variable to set your desired setting. The environment variables get written to the `require/settings.php` file on container start, so any configuration items applied via with `/install/` area may be overwritten. Long story short, your first port of call for configuration should be environment variables.

## Quick Start with `docker-compose` using external database

**NOTE**: The Docker command provided in this quick start is given as an example and parameters should be adjusted to suit your needs.
Expand Down Expand Up @@ -145,13 +120,6 @@ services:
- flightairmap_db
```

On the first run of the container, the database will be created & populated and data will be downloaded from the internet. This process can take quite some time. On my system, around 30 minutes. Once the first run processes are finished, to access FlightAirMap, you can:

- Browse to `http://dockerhost:8080/` to access the FlightAirMap GUI.
- Browse to `http://dockerhost:8080/install/` to access the FlightAirMap settings area.

With regards to settings - where one exists, you should use an environment variable to set your desired setting. The environment variables get written to the `require/settings.php` file on container start, so any configuration items applied via with `/install/` area may be overwritten. Long story short, your first port of call for configuration should be environment variables.

### Environment Variables

To customize some properties of the container, the following environment
Expand Down

0 comments on commit 3a8885c

Please sign in to comment.