Neptune's Potato Monsters

    ssl-expiry-reminder

    0.2.14 • Public • Published

    SSL Expiry Reminder 🔔

    Github Workflow

    SSL Expiry Reminder and SSL Status Checker - Get SSL Expiry Notification reminder on Telegram and Gotify.

    Gotify

    SSL Expiry Reminder Gotify

    Telegram

    SSL Expiry Reminder Telegram

    If you Like My Work then Buy a Coffee for me 😄

    Buy Me A Coffee

    Requirements

    🔧 Installation

    • Clone this Repo via Git
    git clone https://github.com/mskian/ssl-expiry-reminder.git
    cd ssl-expiry-reminder
    npm install
    • Used as CLI
    npm link

    (OR)

    • Install via npm
    npm install -g ssl-expiry-reminder
    $ checkssl -h
    Usage: check [options]
    
    Options:
      -V, --version                                      output the version number
      -d, --domain <domain name>                         Add domain without http/https (This Command line Argument for Automation Task)
      -s, --status <domain name>                         Add domain without http/https
      -g, --gotify <GOTIFY API URL>                      Gotify URL with Application Key
      -t, --telegram <Telegram API URL>                  Telegram API URL with your Bot Key
      -c, --chatid <Telegram Chat or Channel ID>         Telegram Channel ID or Chat ID
      -r, --remainder <Enter the Day Remaining 1 to 10>  Enter the Remaining Day to Get SSL Expiry Remainder Alert
      -h, --help                                         output usage information
    • Next Store your Telegram & Gotify API by using this Below Command lines
    $ Register Gotify API with URL
    checkssl --gotify https://push.example.com/message?token=XXXXXXXXXXXXXXX
    $ Register Telegram API URL and Botkey
    checkssl --telegram https://api.telegram.org/bot<YOUR BOT API KEY>/sendMessage
    $ Register Telegram your Chat id or Channel id
    checkssl --chatid 123456789
    • Testing - Execute the Script
    checkssl --status example.com
    • Test via npx
    npx ssl-expiry-reminder -h

    🕹 Usage

    For Automation it having Seperate Command Line Argumet it will Send the Push Notification Alert via Telegram & Gotify

    checkssl -d example.com
    • Install the Bash Script for Automated Task
    • Download the bash script on Any Location in your Server
    wget https://raw.githubusercontent.com/mskian/ssl-expiry-reminder/master/sslcheck.sh
    • Just Run the Bash file sslcheck.sh
    chmod +x sslcheck.sh
    ./sslcheck.sh

    🛠 Customization

    • Change SSL Remaining Day (Default Remaining day is 5)
    • Add your Own 👇 Example
    checkssl --remainder 2

    📦 API Storage

    Linux - ~/.config in Home
    Windows - AppData Folder c:\Users\username\AppData\Roaming\ssl-expiry-reminder-nodejs
    macOS - ~/Library/Application Support

    🖥 Supported OS

    • I am using Linux also I am using Linux Cloud VPS Server (Ubuntu) I am testing it on both LTS Version on Ubuntu it's Working Well

    • Locally you can use this on your Desktop/laptop with Linux Distro/Windows/macOS

    • I Locally tested it on tested on Windows 10 it's Working well but Some users facing an issues like checkssl is not recongized as an internal or external command, operable program or batch file if you are facing this issue on your Windows System Just uninstall & reinstall the Node.js LTS version & try again

    📖 Library

    SSL Checker NPM Module - https://github.com/mskian/ssl-checker-node-api

    🏗 Contributions

    Your PR's are Always welcome 🦄

    🐛 Bug Report

    If you find any issues create an issue Ticket Here https://github.com/mskian/ssl-expiry-reminder/issues

    License

    MIT

    Install

    npm i ssl-expiry-reminder

    DownloadsWeekly Downloads

    2

    Version

    0.2.14

    License

    MIT

    Unpacked Size

    32.9 kB

    Total Files

    5

    Last publish

    Collaborators

    • mskian