pyro-sys-setup

Set-up and manage Pyronear hardware fire detection systems.

Setup

1. Install raspberry pi os

Please follow the steps in RPI_INSTALLATION to have a rapsberry pi properly running

2. Configuration requirements

To configure the raspberry pi, you need to provide the following configuration files:

Files supposed to be available at the root of this repository, but you can change path in rpi_config.env, see below

• .env file as requested in pyro-engine.
• credentials.json as requested in pyro-engine.
• Authorized public keys files in SSH_PUB_KEYS directory.
• An OpenVPN (.ovpn) configuration file.
• A env file named rpi_config.env fullfilled with your information

So your rpi_config.env file should look like something similar to:

PI_HOST="THE ACTUAL IP ADRESS OF YOUR RPI" 

## SSH KEYS
# Path to directory containing SSH public keys
SSH_KEYS_DIR_PATH="PATH_TO_DIRECTORY_CONTAINING_SSH_PUB_KEYS"

## VPN config info
OPENVPN_CONFIG_FILE_PATH="PATH_TO_YOUR_OPEN_VPN_FILE.ovpn"
OPEN_VPN_PASSWORD="THE_RPI_OPEN_VPN_PASSWORD"

## pyro-engine config files
PYROENGINE_ENV_FILE_PATH="PATH_TO_PYROENGINE_ENV_FILE_NAME.env"
PYROENGINE_CREDENTIALS_LOCAL_PATH="PATH_TO_credentials.json"

## Network
# Wifi OPTIONAL
# Configuring a wifi is optional here, you can let the following variables as an empty string if you do not want to setup a wifi access
WIFI_SSID=""   #NAME_THE_WIFI_ACESS_POINT
WIFI_PASSWORD=""

# Static ip
STATIC_ETHERNET_IP="169.254.40.99"
DEFAULT_DNS="8.8.8.8 8.8.4.4"

3. Setting up the raspberry pi & run the services

Once configuration requirements are fullfilled, from the root of this repository run :

you will be asked the password you define previously

bash setup_rpi.sh

Contributing

Please refer to CONTRIBUTING if you wish to contribute to this project.

Credits

This project is developed and maintained by the repo owner and volunteers from Pyronear.

License

Distributed under the Apache 2 License. See LICENSE for more information.