Giter Club home page Giter Club logo

tims-beacon-service's Introduction

Tims Beacon Service v1.5.4

Tims Beacon-Service keeps track of all your computers (uptime, cpu-temperature, IPs, last time seen, uptime of system, etc.).

It is especially helpful for Raspberry PIs when you don't have a screen attached.

  • easy to install
  • Simple overview over all monitored systems
  • ready for self-hosting, SQL-DB required

By the way: Don't mix up Beacons with delicious Bacon ! :)

Example Installation

Server Requirements

  • WebServer with PHP 5.6 or higher
  • MySQL Database

Installation on Server

  1. Copy all files from /serverFiles to your server directory.

  2. Security: Make sure you copied .htaccess & .htpasswd and as well inserted your credentials to ensure nobody except you can view your vulnurable information. Without this files everyone could access your Beacon-Information-Page!

If you want you can use a .htpasswd-generator to create your .htaccess & .htpasswd files. For example you can use this one: https://www.askapache.com/online-tools/htpasswd-generator/

  1. Enter your MySQL DB Credentials into db_connection.php.
  2. Use the /serverFiles/createTable.sql on your DB to create initale Table-Structure
  3. Open https://YOURSERVER/lastKnownIp.php to view the data send by the clients.

Installation on Client

  1. Just copy the /clientFiles/sendBeacon.sh to your Clients home folder
  2. Change the deviceName Variable & the serveradress in the sendBeacon.sh
  3. Make sure sendBeacon.sh is executable: chmod +x sendBeacon.sh
  4. Add the following line to your crontab (type crontab -e in your console) this will call the script every minute:

* * * * * bash sendBeacon.sh

Payloads

  • You can send payloads (any String) with the beacons

help - I have no curl

In case you don't have curl on your device (for example on some minimal OpenWRT Routers) you can replace it in the Bash-File with http PUT instead. The package needed to be install in openWrt is called httpie.

http PUT https://YOURSERVER/hey.php whois=DEVICENAME

Project details

Author: Tim Lüdtke (https://timluedtke.de)

Version 1.5.4 (Dez 2023)

Graphics

Logo-Image is licensed under CC-BY-3.0 by author: pixelbuddha Source: https://commons.wikimedia.org/wiki/File%3ABeacon_ballonicon2.svg

tims-beacon-service's People

Contributors

timluedtke avatar

Stargazers

 avatar

Watchers

 avatar

tims-beacon-service's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.