https://github.com/RealDudePerson/beakon

Location sharing made private.
https://github.com/RealDudePerson/beakon

Last synced: 2 months ago
JSON representation

Location sharing made private.

• Host: GitHub
• URL: https://github.com/RealDudePerson/beakon
• Owner: RealDudePerson
• License: mit
• Created: 2022-02-01T16:35:47.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-12T03:00:52.000Z (over 1 year ago)
• Last Synced: 2024-08-02T06:14:36.021Z (6 months ago)
• Language: JavaScript
• Size: 749 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• Self-Hosting-Guide - Beakon - A self-host location sharing webserver. Beakon aims to leak as little data as possible and uses mostly self-contained libraries and local database files. Where possible, it will reference local files and not reach out over any network. (Tools for Self-Hosting / Web servers)

README

        
# Beakon

Beakon is designed to be a self-host location sharing webserver. Beakon aims to leak as little data as possible and uses mostly self-contained libraries and local database files. Where possible, it will reference local files and not reach out over any network. One area where this is not yet easy, is map tiling images.

![Screen Shot 2022-07-07 at 07 23 30](https://user-images.githubusercontent.com/4443705/177797804-51bdda0a-1f21-43f5-8ccd-7c2cae18cedf.png)



## Setup

Create a [mapbox] account and generate an access token. Place that in the app.cfg file.

Generate a random string for the SECRET_KEY in the app.cfg file.

Load the site.

### Threat Model

This is completely built in my little spare time as a project to learn flask. This is my first flask project. This should not be used public facing, and if it is used public facing, disable registration once you have setup accounts.

Registered users are assumed to be good actors.

## Dependencies

### Python

flask

flask_sqlalchemy

flask_login

pyOpenSSL

### HTML/CSS/JS

[foundation]

[leaflet]

### Hosted Dependencies

[mapbox]

### Useful Third Party Tools

[GPSLogger] is an open source android app that can automatically send requests to update your location in Beakon.

In GPSLogger you can use the 'Log to custom URL' feature to update your location in the background. The URL endpoing is /api/recordlocation.

The request should be sent as a json payload in the following format with the following headers:

Headers:

> Content-Type: application/json

> username: [username]

> secret: [API Key created from account page]

Body:

> {"lat":"%LAT","lon":"%LON","acc":"%ACC"}

[mapbox]: https://www.mapbox.com/

[leaflet]: https://github.com/Leaflet/Leaflet

[foundation]: https://github.com/foundation/foundation-sites

[gpslogger]: https://gpslogger.app