Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turbo87/ogn-web-gateway
OpenGliderNet Web-Gateway
https://github.com/turbo87/ogn-web-gateway
actix aprs ogn openglidernet websocket
Last synced: 7 days ago
JSON representation
OpenGliderNet Web-Gateway
- Host: GitHub
- URL: https://github.com/turbo87/ogn-web-gateway
- Owner: Turbo87
- License: apache-2.0
- Created: 2018-05-22T22:35:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T18:44:54.000Z (8 months ago)
- Last Synced: 2024-05-02T00:10:52.845Z (8 months ago)
- Topics: actix, aprs, ogn, openglidernet, websocket
- Language: Rust
- Homepage: https://ogn.cloud/api/status
- Size: 669 KB
- Stars: 13
- Watchers: 4
- Forks: 4
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
ogn-web-gateway
==============================================================================
[](https://travis-ci.org/Turbo87/ogn-web-gateway)
[OpenGliderNet] Web-Gateway
[OpenGliderNet]: http://wiki.glidernet.org/
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]:
```bash
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:
```bash
export REDIS_URL=redis://localhost
```
Finally we can use [cargo] to download all necessary dependencies, compile the
application and then run it:
```bash
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.
[Redis]: https://redis.io/
[git]: https://git-scm.com/
[cargo]: https://doc.rust-lang.org/cargo/
API Documentation
------------------------------------------------------------------------------
For the API documentation please have a look at the [`docs`](docs) folder.
License
------------------------------------------------------------------------------
This project is licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
)
at your option.