Badges
Getting Started
Before you start, you need to install the prerequisites.
Prerequisites
- Redis:
Version >= 5.0for data reading - GO:
Version >= 1.18for building - Node.js:
Version >= 14.0for building - Yarn or NPM: for building
Install from binary
Downloads can be found at releases page on GitHub.
Install from source
- Clone the repository:
git clone [email protected]:petaki/satellite.git
- Open the folder:
cd satellite
- Install the UI dependencies
yarn install
- Build the UI
yarn prod
- Build the Satellite:
go build
- Copy the example configuration:
cp .env.example .env
Configuration
The configruation is stored in the .env file.
Application Address:
APP_ADDR=:4000
Application URL:
APP_URL=http://127.0.0.1:4000
Redis URL:
REDIS_URL=redis://127.0.0.1:6379/0
Redis Key Prefix:
REDIS_KEY_PREFIX=probe:
Usage
Run the app using the following command:
./satellite web serve
Data Collection
You can gather the necessary data with the Probe.
Reporting Issues
If you are facing a problem with this package or found any bug, please open an issue on GitHub.
License
The MIT License (MIT). Please see License File for more information.