https://github.com/mskian/ssl-expiry-reminder
SSL Expiry Reminder - Get Notification remainder on Telegram and Gotify
https://github.com/mskian/ssl-expiry-reminder
bash gotify javascript linux push-notifications ssl ssl-expiry ssl-expiry-reminder sslchecker telegram telegram-bot
Last synced: 11 months ago
JSON representation
SSL Expiry Reminder - Get Notification remainder on Telegram and Gotify
- Host: GitHub
- URL: https://github.com/mskian/ssl-expiry-reminder
- Owner: mskian
- License: mit
- Created: 2019-08-20T04:12:14.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-08-01T20:53:19.000Z (11 months ago)
- Last Synced: 2025-08-09T16:45:21.945Z (11 months ago)
- Topics: bash, gotify, javascript, linux, push-notifications, ssl, ssl-expiry, ssl-expiry-reminder, sslchecker, telegram, telegram-bot
- Language: JavaScript
- Homepage:
- Size: 454 KB
- Stars: 25
- Watchers: 5
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# SSL Expiry Reminder 🔔
[](https://github.com/mskian/ssl-expiry-reminder/actions)
SSL Expiry Reminder and SSL Status Checker - Get SSL Expiry Notification reminder on Telegram and Gotify.
## Gotify
## Telegram
If you Like My Work then Buy a Coffee for me 😄
[](https://www.buymeacoffee.com/santhoshveer)
## ⚙ Requirements
- Node 14X LTS or 16X LTS
- Bash script to Run the Automated Tasks
- Telegram Bot -
- Gotify API -
## 🔧 Installation
- Clone this Repo via Git
```bash
git clone https://github.com/mskian/ssl-expiry-reminder.git
cd ssl-expiry-reminder
npm install
```
- Used as CLI
```bash
npm link
```
(OR)
- Install via `npm`
```bash
npm install -g ssl-expiry-reminder
```
```bash
$ checkssl -h
Usage: check [options]
Options:
-V, --version output the version number
-d, --domain Add domain without http/https (This Command line Argument for Automation Task)
-s, --status Add domain without http/https
-g, --gotify Gotify URL with Application Key
-t, --telegram Telegram API URL with your Bot Key
-c, --chatid Telegram Channel ID or Chat ID
-r, --remainder 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
```bash
$ Register Gotify API with URL
checkssl --gotify https://push.example.com/message?token=XXXXXXXXXXXXXXX
```
```bash
$ Register Telegram API URL and Botkey
checkssl --telegram https://api.telegram.org/bot/sendMessage
```
```bash
$ Register Telegram your Chat id or Channel id
checkssl --chatid 123456789
```
- Testing - Execute the Script
```bash
checkssl --status example.com
```
- Test via `npx`
```sh
npx ssl-expiry-reminder -h
```
## 🕹 Usage
For Automation it having Seperate Command Line Argumet it will Send the Push Notification Alert via Telegram & Gotify
```bash
checkssl -d example.com
```
- Install the Bash Script for Automated Task
- Download the bash script on Any Location in your Server
```bash
wget https://raw.githubusercontent.com/mskian/ssl-expiry-reminder/master/sslcheck.sh
```
- Just Run the Bash file `sslcheck.sh`
```bash
chmod +x sslcheck.sh
```
```bash
./sslcheck.sh
```
- Replace mine Sites domain with your's
- Create Cron job for Automate checking
## 🛠 Customization
- Change SSL Remaining Day (Default Remaining day is 5)
- Add your Own 👇 Example
```bash
checkssl --remainder 2
```
## 📦 API Storage
- Your API Key's and URL's are stored on your Disk in `JSON File` Example File -
- Folder name - `ssl-expiry-reminder-nodejs` and File Name `config.json`
- You **No need** to create this File and Folder it will Automatically Generate & Store your Data's
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 -
## 🏗 Contributions
Your PR's are Always welcome 🦄
## 🐛 Bug Report
If you find any issues create an issue Ticket Here ✉
## ☑ License
MIT