Git Product home page Git Product logo

ssl-expiry-reminder's Introduction

SSL Expiry Reminder ๐Ÿ””

dependencies Status Build Status Github Workflow

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

SSL Expiry Reminder

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

๐Ÿ•น 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://www.npmjs.com/package/ssl-checker

๐Ÿ— 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

๐Ÿ“ Changelogs

v0.2.2

  • Update dependencies

v0.2.1

  • Correct the Spelling Errors
  • Update dependencies

v0.2.0

  • No Changes - Update the test URL Only

v0.0.9

  • Add Github Actions Workflows

v0.0.8

  • Replace Response data with Custom error message in teleram and gotify function

v0.0.7

  • Improved Readme

v0.0.6

  • Update Gotify Push title

v0.0.5

  • New Command to check domain SSL Status checlssl -s example.com
  • Travis Build Test

v0.0.4

  • Minor Changes in package.json

v0.0.3

  • Minor Update (Some Changes in Readme File)

v0.0.2

  • Not much Changes

v0.0.1

  • Revamped the Entire Script
  • Version Changes
  • Converted to CLI by using commander Module
  • replace .env with conf https://github.com/sindresorhus/conf
  • Add extra validation
  • Published in NPM
  • Now Easy to use and Manage

v0.0.1-beta

  • Revamp
  • using Axios for Telegram instead of telegram-bot-api Module
  • Proper Input and Output Validation
  • Correct the version Number in package.json

v0.0.2-beta

  • Update dependencies
  • Migrate SSL Checker Module to Latest JSON response

โ˜‘ License

MIT

ssl-expiry-reminder's People

Contributors

dependabot-preview[bot] avatar mcnaveen avatar mskian avatar renovate-bot avatar

Watchers

 avatar

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.