Skip to main content

Manual in English - Standard Procedure

#

RadarView Feeder Configuration Guide

This guide provides instructions on how to set up and configure the RadarView feeder on your system.

##

Prerequisites

Prerequisites

    * **

  • Git:** You will need Git installed to clone the repository for the standard setup.
    *
  • **
  • Root Access:** You must run the setup script with root privileges (e.g., using `sudo`sudo).
    *
  • **
  • Python:** Python 3 or Python 2 must be installed on your system. The script will attempt to detect the correct version.
    *
  • **
  • Systemd:** The scripts are designed for systems using systemd for service management.
    *
  • **
  • Internet Connection:** Required for cloning the repository, downloading necessary files (e.g., `dump1090-fa`fa if not installed, or `radarview.py`py if it's fetched by the script directly in some cases).
    *
  • **
  • RadarView Token:** You will need a RadarView token in the format `ADS-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX. You can obtain your token by registering an account on the RadarView website. Please note that Feeder Account activation and for the feeder to show as online can take up to 5 minutes after the setup is complete and the service is running.

---

 

## Installation Methods {.tabset}

### Standard Setup (using Git)

This method involves cloning the RadarView repository from GitHub, which contains the `radarview_setup.sh`sh script and the `radarview.py`py feeder script.

**Steps:**

  1. 1.  **Clone the Repository:**
     
    Open a terminal and clone the repository:


    ```bash
    git clone [https://github.com/br3jski/radarview.git](https://github.com/br3jski/radarview.git)
    ```

  2. 2.  **Navigate to Script Directory:**
     
    Change to the directory created by cloning:


    ```bash
    cd radarview
    ```
       

    (The `radarview_setup.sh`sh and `radarview.py`py scripts should be in this directory).

  3. 3.  **Make the Setup Script Executable:**


    ```bash
    chmod +x radarview_setup.sh
    ```

  4. 4.  **Run the Setup Script:**
     
    Execute the script with root privileges:


    ```bash
    sudo ./radarview_setup.sh
    ```

  5. 5.  **Enter Your RadarView Token:**
     
    When prompted, enter your RadarView token. The script will validate its format.


    ```
    Please enter your RadarView token (format: ADS-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX): YOUR_TOKEN_HERE
    ```

  6. 6.  **Dump1090 Installation (if needed):**
     
    The script will check if `dump1090-fa`fa, `dump1090-mutability`mutability, `dump1090`dump1090, or `readsb`readsb is installed.

      *
    • If none are found, it will ask if you want to install `dump1090-fa`fa:

      ```
      Dump1090 / reADSB are not installed. Do you want to install it now? (y/n)
            ```
       
      Press `y`y and Enter to install it. If you choose `n`n, the setup will exit.

  7. 7.  **Configuration and Service Creation:**
     
    The script will then perform the following actions:

      *
    • It will use the `radarview.py`py from the current (cloned) directory. If, for some reason, `radarview.py`py is missing from the directory *but*but `radarview_setup.sh`sh is run, the setup script itself might attempt to download it as a fallback (as per its internal logic: `if [ ! -f radarview.py ]; then wget ...; fi`fi).
    •   *
    • Copy `radarview.py`py to `/opt/radarview.py`py and make it executable.
    •   *
    • Update `/opt/radarview.py`py with your provided `USER_TOKEN`USER_TOKEN.
    •   *
    • Create a systemd service file at `/etc/systemd/system/radarview.service`service to manage the feeder.
    •   *
    • The service will be configured to run `/opt/radarview.py`py using the detected Python command.
    •   *
    • Reload the systemd daemon, start the `radarview`radarview service, and enable it to start on boot.

  8. 8.  **Completion:**
     
    Once these steps are complete, you'll see a message:


    ```
    RadarView setup completed successfully.
    ```

**What the script does:**
*

  • Validates and stores your RadarView token.
    *
  • Ensures `radarview.py`py is in `/opt/` and configured with your token.
    *
  • Sets up a systemd service named `radarview`radarview to run the feeder automatically.
    *
  • Optionally installs `dump1090-fa`fa if no ADS-B decoder is found.

  • ###

No-Git Setup (using radarview_setup-nogit.sh)

This method is for users who have downloaded only the `radarview_setup-nogit.sh` script. This script will always download the `radarview.py` feeder script from the internet.

**Steps:**
1.  **Download the script:**
    Download the script using wget or curl. Below example is made with wget.
    ```bash
    wget https://raw.githubusercontent.com/br3jski/radarview/refs/heads/main/radarview_setup-nogit.sh .
    ```

2.  **Make the Setup Script Executable:**
    ```bash
    chmod +x ./radarview_setup-nogit.sh
    ```

3.  **Run the Setup Script:**
    Execute the script with root privileges:
    ```bash
    sudo ./radarview_setup-nogit.sh
    ```

4.  **Enter Your RadarView Token:**
    When prompted, enter your RadarView token. The script will validate its format.
    ```
    Please enter your RadarView token (format: ADS-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX): YOUR_TOKEN_HERE
    ```

5.  **Dump1090 Installation (if needed):**
    The script will check if `dump1090-fa`, `dump1090-mutability`, `dump1090`, or `readsb` is installed.
    * If none are found, it will ask if you want to install `dump1090-fa`:
        ```
        Dump1090 / reADSB are not installed. Do you want to install it now? (y/n)
        ```
        Press `y` and Enter to install it. If you choose `n`, the setup will exit.

6.  **Configuration and Service Creation:**
    The script will then perform the following actions:
    * Download `radarview.py` from `https://raw.githubusercontent.com/br3jski/radarview/main/radarview.py` to `/opt/radarview.py` and make it executable.
    * Update `/opt/radarview.py` with your provided `USER_TOKEN`.
    * Create a systemd service file at `/etc/systemd/system/radarview.service` to manage the feeder.
    * The service will be configured to run `/opt/radarview.py` using the detected Python command.
    * Reload the systemd daemon, start the `radarview` service, and enable it to start on boot.

7.  **Completion:**
    Once these steps are complete, you'll see a message:
    ```
    RadarView setup completed successfully.
    ```

**What the script does:**
* Validates and stores your RadarView token.
* Downloads `radarview.py` to `/opt/` and configures it with your token.
* Sets up a systemd service named `radarview` to run the feeder automatically.
* Optionally installs `dump1090-fa` if no ADS-B decoder is found.

## {-}

---

##

Post-Installation Checks

After the installation, you can verify that the service is running correctly:

  1. 1.  **Check Service Status:**


    ```bash
    sudo systemctl status radarview.service
    ```
       

    You should see output indicating the service is active (running). Remember, it might take up to 5 minutes for your feeder to appear as online in your RadarView account.

  2. 2.  **View Logs (if needed):**
     
    If you encounter issues, you can check the logs for the service:


    ```bash
    sudo journalctl -u radarview.service -f
    ```
       

    This will show the live logs. Press `Ctrl+C`C to exit.

    ##

Feeder Script Overview (`radarview.py`py)

The `radarview.py`py script is responsible for:
*

  • Connecting to a local data source (typically `dump1090`dump1090 or a similar ADS-B decoder) at `127.0.0.1:30003`30003.
    *
  • Receiving ADS-B data from this local source.
    *
  • Preparing a token message using your `USER_TOKEN`USER_TOKEN.
    *
  • Forwarding each line of ADS-B data, prefixed by the token message, to the RadarView server at `feed.ads-b.pro:48581`48581.
    *
  • If the connection drops, it will attempt to reconnect after a short delay.

  • ##

Troubleshooting

*

    **
  • "Python not found"**: Ensure Python (version 2 or 3) is installed and available in your system's PATH.
    *
  • **
  • "Failed to download radarview.py"**: Check your internet connection and that `wget`wget is installed. Ensure the URL `https://raw.githubusercontent.com/br3jski/radarview/main/radarview.py`py is accessible.
    *
  • **
  • "Failed to update radarview.py with token"**: This might indicate a permissions issue or an unexpected format of the `/opt/radarview.py`py file. Check the file manually.
    *
  • **
  • Service not starting**starting: Use `sudo journalctl -u radarview.service`service to check for errors. Common issues could be incorrect Python path in the service file, `dump10090`dump10090 not running or not providing data on port 30003, or network connectivity issues to `feed.ads-b.pro`pro.
    *
  • **
  • Token Format Error**Error: Double-check that you are entering the token exactly as provided, in the format `ADS-` followed by 32 hexadecimal characters.
    *
  • **
  • No additional functionalities available**available: Allow up to 5 minutes after the service starts for the feeder to register and show as online in our system. Ensure `dump1090`dump1090 (or equivalent) is running and outputting data on port 30003 locally.

If you continue to experience issues after checking these steps, please send an email to `info@ads-b.pro`pro. Kindly include your RadarView Feeder Token in your email for faster investigation.