Skip to content

Commit

Permalink
chore: link to docs in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
johanohly committed Sep 8, 2024
1 parent 663434c commit 91c1dd2
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 59 deletions.
60 changes: 5 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<div align="center">
<a href="https://github.com/JohanOhly/AirTrail">
<a href="https://johanohly.github.io/AirTrail/">
<img src="static/favicon.png" alt="AirTrail logo" width="80" height="80">
</a>

<h3 align="center">AirTrail</h3>
<h3 align="center">AirTrail</h3>

<p align="center">
A web application that allows users to track their flights and view their flight history.
Expand All @@ -24,59 +24,9 @@

## 🚀 Getting Started

Docker Compose is the recommended way to run the application. The following steps will guide you through the process.

### Step 1: Download the required files

Create a new directory to hold the `docker-compose.yml` and `.env` files.

```bash
mkdir airtrail
cd airtrail
```

Download the `docker-compose.yml` and `.env` files.

```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/JohanOhly/AirTrail/main/docker-compose.yml
wget -O .env https://raw.githubusercontent.com/JohanOhly/AirTrail/main/.env.example
```

or download the files manually from the repository.

Note: If you download the files manually, the `.env.example` file should be renamed to `.env`.

### Step 2: Configure the environment variables

- Set the `ORIGIN` variable to the domain name or IP address that the application will be accessed from.
- Populate custom database information if necessary.
- Consider changing DB_PASSWORD to a custom value. Postgres is not publically exposed, so this password is only used for
local authentication. To avoid issues with Docker parsing this value, it is best to use only the characters A-Za-z0-9.

### Step 3: Start the application

From the directory where the `docker-compose.yml` amd `.env` files are located, run the following command:

```bash
docker compose up -d
```

> [!NOTE]
> If you get an error `unknown shorthand flag: 'd' in -d`, you are probably running the wrong Docker version. (This
> happens, for example, with the docker.io package in Ubuntu 22.04.3 LTS.) You can correct the problem by `apt remove`
> ing
> Ubuntu's docker.io package and installing docker and docker-compose
> via [Docker's official repository](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository).
>
> Note that the correct command really is `docker compose`, not `docker-compose`.
### Step 4: Upgrading

When a new version of the application is released, you can upgrade by running the following command:

```bash
docker compose pull && docker compose up -d
```
- [Documentation](https://johanohly.github.io/AirTrail/docs/)
- [Installation](https://johanohly.github.io/AirTrail/docs/overview/quick-start/)
- [About](https://johanohly.github.io/AirTrail/docs/overview/introduction)

## Acknowledgements

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1
The import feature allows you to import flight data from other sources into AirTrail.
Currently, AirTrail only supports importing flights from [MyFlightradar24](https://my.flightradar24.com).

## Import Flights from MyFlightradar24
## Import flights from MyFlightradar24

While logged in to your MyFlightradar24 account, follow these steps to export your flights:

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/install/post-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ sidebar_position: 3

Right after you have AirTrail up and running, you should follow the steps below to get started.

## Register the Owner User
## Register the owner user

The first thing you should do is to create the owner user. This user will have full access to the AirTrail application.
When you visit the AirTrail application for the first time, you will be guided through the owner user registration process.

## Create other Users
## Create other users

If you have friends or family members who want to use AirTrail to track their flights as well, you can create user accounts for them.

To create a new user, go to the settings page, and click on the "Users" tab. Enter the required information and click on the "Add User" button.

## Add Flights
## Add flights

Start adding flights to your account to see the map slowly fill up with your flight paths. You can add flights manually or [import them](/docs/features/import) from various sources.

0 comments on commit 91c1dd2

Please sign in to comment.