am-i-alive-nodejs

Make it easy for people to check if you are alive or not.
git clone http://git.hanabi.in/repos/am-i-alive-nodejs.git
Log | Files | Refs | LICENSE

README.asc (1728B)

      1                                      _         _ _           
      2                     __ _ _ __ ___   (_)   __ _| (_)_   _____ 
      3                    / _` | '_ ` _ \  | |  / _` | | \ \ / / _ \
      4                   | (_| | | | | | | | | | (_| | | |\ V /  __/
      5                    \__,_|_| |_| |_| |_|  \__,_|_|_| \_/ \___|
      6                                                              
      7 ---
      8 
      9 Make it easy for people to check if you are alive or not.
     10 
     11 Requirements
     12 ============
     13 0. sqlite3
     14 1. NodeJS
     15 
     16 Installation
     17 ============
     18 
     19 $ git clone https://git.hanabi.in/acagastya/am-i-alive
     20 $ cd am-i-alive
     21 $ npm i -D // or yarn
     22 $ sqlite3 am-i-alive.db -init init-db.sql
     23 
     24 Configuration
     25 =============
     26 
     27 Update config.js to
     28 0. port: specify which port to run the server.
     29 1. auth: Authentication password.
     30 2. name: Name by which you are known.
     31 
     32 Usage
     33 =====
     34 
     35 Try running the following command to see if the tool is working fine.
     36 
     37 $ curl -XPOST -H "Content-type: application/json" -d '{ "auth": "YOUR-PASSWORD" }' 'https://example.com/update'
     38 
     39 Run this command periodically so others know if you are alive or not.
     40 I have placed the command in my .zshrc.
     41 I use my terminal a lot, and therefore it updates my status regularly.
     42 I have also provided homepage.html.  Update the password and the URL, and point your web-browser's "New Tab" to that webpage.
     43 
     44 People who want to know your status can run the following command to check on you.
     45 
     46 $ curl -XGET 'https://example.com/'
     47 
     48 If someone who wants to know about you is not user to cUrl, they can still open the URL to see the message.
     49 
     50 Sure, the message is not as pretty.
     51 But it should not take much time to set up a front-end to this.
     52 
     53 This is a very minimal tool under a free license.  Tweak it to your liking.