Turbo87/ogn-web-gateway

📄 README.md

ogn-web-gateway ==============================================================================

[OpenGliderNet] Web-Gateway

This project contains a webserver that connects to the [OpenGliderNet], saves the received records to a database for 24 hours and relays all data to any connected WebSocket clients.

Installation & Usage

ogn-web-gateway is using the in-memory database [Redis] as the data store for the History API. Before attempting to install ogn-web-gateway make sure to have a working Redis server running.

Next, you should clone this repository using [git]:

git clone https://github.com/Turbo87/ogn-web-gateway.git

Before continuing make sure to set the REDIS_URL environment variable so that ogn-web-gateway known what Redis server it should try to connect to:

export REDIS_URL=redis://localhost

Finally we can use [cargo] to download all necessary dependencies, compile the application and then run it:

cargo run --release

By default ogn-web-gateway does not produce any console output when running, so don't be surprised. Once it is running you should be able to visit to verify that everything runs correctly.

API Documentation

For the API documentation please have a look at the docs folder.

License

This project is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or

)

MIT license (LICENSE-MIT or

)

at your option.