Browse Source

Concept kickoff

udp-mqtt
Felix 2 years ago
parent
commit
4f9bd54199
  1. 31
      LICENSE
  2. 26
      README.md

31
LICENSE

@ -198,34 +198,3 @@ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY C
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.

26
README.md

@ -1,3 +1,27 @@
# goshawk
Goshawk is a small fleet management and outdoor tracking project written in Go
Goshawk is a small fleet management and outdoor tracking project written in Go
# Concept
goshawk is a small self-hosted server-based project than keeps track of small self-build trackers and stores the data in a convenient and accessible way on your own server
## Requirements
Mission statement: **Small, elegant, fast** - The server should be able to easily run on a Raspberry pi for years without worrying about.
* Webserver: REST-API
* Backend: Binary file based (for efficiency)
* System configuration: Simple configuration file (INI Style)
* System database: SQLite3
* Location data: Binary file
* Receiver of location data
* Mosquitto (for owntracks)
* UDP receiver with AES256 encryption
* Via Web-API
* Live-Query
* TCP socket (SSL and non-SSL) with subscribe-pattern
Request should be primarily handled via the REST-API. The TCP-Socket serves as observable for live tracking of future applications.
The whole data-storage should be in a single folder to allow easy backup and synchronisation with other servers (for redundancy).
Loading…
Cancel
Save