Giter Club home page Giter Club logo

new-members's Introduction

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

Requirements ๐Ÿ›

  • Telegram Bot API Key and Chat ID
  • Gotify API Key - https://github.com/gotify
  • 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<YOUR BOT API KEY>/sendMessage
CHAT_ID <Channel ID or 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 ๐Ÿ› 

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<YOUR BOT API KEY>/sendMessage
CHAT_ID=<Channel ID or CHAT ID>
GOTIFY_URL=https://push.example.com/message?token=XXXXXXXXXXXXXXX
SITE_DOMAIN=example.com

## Test
yarn start -s example.com

LICENSE ๐Ÿ“œ

MIT

new-members's People

Contributors

dependabot[bot] avatar mskian avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

titenkov

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.