Files
postgsail/README.md
2024-04-23 16:37:28 +02:00

6.0 KiB
Raw Blame History


Logo

PostgSail

PostgSail is an open-source alternative to traditional vessel data management!

Explore the docs »

View Demo . Report Bug . Request Feature

release License issues - postgsail PRs Welcome Contributors

Test services db, api Test services db, api, web Test services db, grafana

signalk-postgsail: GitHub Release

postgsail-frontend: GitHub Release

postgsail-telegram-bot: GitHub Release

OpenSSF Best Practices

Table Of Contents

About The Project

https://github.com/xbgmsharp/signalk-postgsail/assets/1498985/b2669c39-11ad-4a50-9f91-9397f9057ee8

Effortless cloud based solution for storing and sharing your SignalK data. Allow you to effortlessly log your sails and monitor your boat with historical data.

Here's how:

It is all about SQL, object-relational, time-series, spatial databases with a bit of python.

PostgSail is an open-source alternative to traditional vessel data management. It is based on a well known open-source technology stack, Signalk, PostgreSQL, TimescaleDB, PostGIS, PostgREST. It does perfectly integrate with standard monitoring tool stack like Grafana.

To understand the why and how, you might want to read Why.md

Cloud-hosted PostgSail

Remove the hassle of running PostgSail yourself. Here you can skip the technical setup, the maintenance work and server costs by getting PostgSail on our reliable and secure PostgSail Cloud. Register and try for free at https://iot.openplotter.cloud/.

On-Premise (for free)

Self host postgSail where you want and how you want. There are no restrictions, youre in full control. Install Guide

Roadmap

See the open issues for a list of proposed features (and known issues).

Join the community, Get support and exchange on Discord. Missing a feature? just ask!

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the Apache License Version 2.0. See LICENSE for more information.

Acknowledgements

An out of the box IoT platform using Docker (could be extend to K3 or K8) with the following software: