https://github.com/mskian/new-members

A Simple Script to Get New Member Registration Notification from your Ghost Site
https://github.com/mskian/new-members

bash bash-script ghost ghost-api ghost-custom ghost-site gotify members-notification netlify netlify-account netlify-webhooks notifications telegram-bot

Last synced: 9 days ago
JSON representation

A Simple Script to Get New Member Registration Notification from your Ghost Site

• Host: GitHub
• URL: https://github.com/mskian/new-members
• Owner: mskian
• License: mit
• Created: 2019-11-06T12:01:24.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-17T02:42:49.000Z (8 months ago)
• Last Synced: 2024-04-13T23:05:24.882Z (7 months ago)
• Topics: bash, bash-script, ghost, ghost-api, ghost-custom, ghost-site, gotify, members-notification, netlify, netlify-account, netlify-webhooks, notifications, telegram-bot
• Language: JavaScript
• Homepage:
• Size: 35.2 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Members Notification 🔔

A Simple Shell Script to Get New Member Registration Notification from your Ghost site via Telegram Bot 🤖 and Gotify Push Notification Server.  

[![deploy](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/mskian/new-members)  

## Requirements 🛍

- Telegram Bot API Key and Chat ID

- Gotify API Key - 

- Netlify Account for Host this Script

- Netlify Webhooks for Trigger the Update from Ghost Dashboard

## Usage 📦

- Hosted at Netlify ☂

- Attach Netlify webhook on your Ghost Custom integration with `Member added` Event

- Telegram Bot 🤖 API and Gotify API Key for sending the Notification Alerts

- Netlify Environment variables for Store the Sensitive Data's like API Key and Extra Variables

## Setup 🔧

- Click the above button to Connect this script to your Netlify Account

- Next it will automatically Create a Respo on your Github or Gitlab Account

- Configure it -> in `build Command` add this `chmod a+x ./members.sh && ./members.sh` Next Choose the Advanced Settings and Add ENV variables yes add your Telegram BOT API Key, Chat ID, Gotify API Key and Site domain  - Key Values 👇

**you can use anyone of the Notification service - Telegram or Gotify**

| key | Value |

| ----------- | ----------- |

| BOT_API | `https://api.telegram.org/bot/sendMessage` |

| CHAT_ID | `` |

| GOTIFY_URL | `https://push.example.com/message?token=XXXXXXXXXXXXXXX` |

| SITE_DOMAIN | `example.com` |

## Ghost Custom integration 🔩

- log on to your Ghost Admin Dashboard

- Goto Integrations

- Click `Add Custom integration` to Create New Ghost Custom integration

- Goto webhooks Column & Create a New Webhook - Give Name for your Webhook - Choose a Event `Member added` - in Target URL add your Netlify webhook URL (How to Get Netlify webhook URL? Goto Settings > Build & Deploy > Build hooks)

- Save the Settings - That's all Successfully setup the Script for Alerts

- Once the Member was Successfully Registered you will get the Notification alert on Telegram & Gotify

## Development 🛠

```bash

git clone https://github.com/mskian/new-members.git

## Install

yarn dependencies

## Test Notifications (Create .env file for API Keys and variables)

touch .env

## Add this on .env file

BOT_API=https://api.telegram.org/bot/sendMessage

CHAT_ID=

GOTIFY_URL=https://push.example.com/message?token=XXXXXXXXXXXXXXX

SITE_DOMAIN=example.com

## Test

yarn start -s example.com

```

## LICENSE 📜

MIT