Download the PHP package lbiltech/telegram-bot-github-notify without Composer

On this page you can find all versions of the php package lbiltech/telegram-bot-github-notify. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of lbiltech/telegram-bot-github-notify

Informations about the package telegram-bot-github-notify

Welcome to Telegram Bot GitHub/GitLab Notify 👋

This package provides the ability to integrate the Telegram messaging service and GitHub/GitLab. With this package, you can create a Telegram bot to receive notifications from GitHub or GitLab events and manage customization through messages and buttons on Telegram.

GitHub and GitLab notifications to telegram php

License Latest Version Test Status Code Style Status StyleCI Quality Score Maintainability

📝 Information

🎉 Features

  1. GitHub/GitLab Notifications to Telegram: The package allows you to configure a Telegram bot to receive notifications from various GitHub/GitLab events, including events like commits, pull requests, issues, releases, and many more.

GitHub/GitLab Notifications to Telegram

  1. Customize Notifications: You can customize the types of notifications you want to receive through options on Telegram.

  2. Interactive Buttons: The package supports creating interactive buttons on Telegram to perform actions such as enabling or disabling notifications.

  3. Event Management: You can manage specific events that you want to receive notifications for, allowing you to focus on what's most important for your projects.

    • Support for multiple platforms: GitHub and GitLab.
    • Manage event notifications separately between platforms.

Event Management to Telegram

  1. Easy Integration: The package provides an API and user-friendly functions to create a Telegram bot and link it to your GitHub/GitLab account.

  2. Support for multiple chats: You can add multiple chat IDs to the .env file. These chat IDs will be the chat IDs of your groups, channels, or users. Also, you can add the chat ID of this bot to receive incoming notifications for itself.

  3. For premium users, you can use the following features:
    • Support for multiple topics: You can add multiple topics to the .env file. These topics will be the topics of your supergroups.

📋 Requirements

🔧 Installation

As for the installation and configuration, this project provides two different installation ways depending on your preference or suitability for your system.

Way 1: Install by composer directly on the system (Requires the system to install composer, previous PHP version)

Way 2: Install by Docker (Requires the system to install Docker, Docker Compose)

I. Installation and configuration 🛠

Please choose only one of the following two ways to set up the project.

Way 1: Install by composer directly on the system ⚙
First, please clone and install this project via [Composer](https://getcomposer.org/): After running the command above, you will have the project installed under the `telegram-git-notifier-app` directory, and the environment file `.env` will be created automatically. Some of the JSON files will be created automatically in the `storage` directory. These files are used to store the data and serve for features in this bot. #### 1. Create a New Bot To create a new bot, you need to talk to [BotFather](https://core.telegram.org/bots#6-botfather) and follow a few simple steps. 1. Open a chat with [BotFather](https://telegram.me/botfather) and send `/newbot` command. 2. Enter a friendly name for your bot. This name will be displayed in contact details and elsewhere. 3. Enter a unique username for your bot. It must end in `bot`. Like this, for example: `TetrisBot` or `tetris_bot`. 4. Copy the HTTP API access token provided by [BotFather](https://telegram.me/botfather) and paste it into your `.env` file. #### 2. Set up your domain and SSL certificate **We recommend that you use HTTPS to set up your domain and webhook.** You can build your own server or use a service like [Heroku](https://www.heroku.com/). In this example, we will use localhost and [ngrok](https://ngrok.com/) to set up the domain and webhook: 1. Download and install [ngrok](https://ngrok.com/download). 2. Go to this project directory and run the command in the terminal: `php -S localhost:8000` 3. Continue to run the command in the terminal: `ngrok http 8000` 4. Copy the HTTPS URL provided by ngrok and paste it into your `.env` file. #### 3. Get your Chat ID and add it to the .env file 1. Open a chat with your bot. 2. Send any message to your bot. (This handle needs to get your chat ID) 3. Go to the following URL: `/webhooks/getUpdate.php` 4. Look for the `"chat":{"id":` field and copy the number after it. This is your Chat ID. 5. Paste the Chat ID in your `.env` file. At this time, the source launch process is done, please skip way 2 and go to step [II. Set the webhook](#ii-set-the-webhook) to continue.
Way 2: Install by Docker :whale:
> **Note:** This way requires the system to install Docker and Docker Compose. > > ⚠ **If you set up the project by way one, please skip this way.** 🚸 > >And go to step [II. Set the webhook](#ii-set-the-webhook) to continue. First, please clone this project and copy the environment file `.env.example` to `.env`: #### 1. Update the environment variables Open the `.env` file and update the following variables: > **Note:** > > - The `PHP_VERSION_SELECTED` variable is the PHP version you want to use in the container. > - The `APP_PORT` variable is the port of the container. (Please don't set the same port as the host) > - The `CONTAINER_NAME` variable is the name of the container you want to create. #### 2. Install and run the container Run the following command to install and run the container: Some of the JSON files will be created automatically in the `storage` directory. These files are used to store the data and serve for features in this bot. #### 3. Create a New Bot To create a new bot, you need to talk to [BotFather](https://core.telegram.org/bots#6-botfather) and follow a few simple steps. 1. Open a chat with [BotFather](https://telegram.me/botfather) and send `/newbot` command. 2. Enter a friendly name for your bot. This name will be displayed in contact details and elsewhere. 3. Enter a unique username for your bot. It must end in `bot`. Like this, for example: `TetrisBot` or `tetris_bot`. 4. Copy the HTTP API access token provided by [BotFather](https://telegram.me/botfather) and paste it into your `.env` file. #### 4. Set up your domain and SSL certificate In this way, we use the proxy in the container and [ngrok](https://ngrok.com/) to set up the domain and webhook: 1. Check the proxy of the container: `docker inspect -nginx | grep IPAddress` > **Note:** Replace `` with the name of the container in .env file. Example: ![image](https://github.com/cslant/lemp-docker/assets/35853002/8dc8ba3f-b1e9-4bff-901d-6bb7747acda4) 2. Download and install [ngrok](https://ngrok.com/download). 2. Continue to run the command in the terminal: `ngrok http ` > **Note:** Replace `` is the IP address of the container in step 1. Example: 3. Copy the HTTPS URL provided by ngrok and paste it into your `.env` file. #### 5. Get your Chat ID and add it to the .env file 1. Open a chat with your bot. 2. Send any message to your bot. (This handle needs to get your chat ID) 3. Go to the following URL: `/webhooks/getUpdate.php` 4. Look for the `"chat":{"id":` field and copy the number after it. This is your Chat ID. 5. Paste the Chat ID in your `.env` file.

II. Set the webhook

We have two ways to set the webhook:

1. Set the webhook from this project

After setting up your domain and SSL certificate, you need to set up the webhook for your bot.

Go to:

Note: Replace <APP_URL> with your app URL in .env file.

If you see the following message, it means that the webhook has been sent successfully.

2. Set the webhook manually from Telegram

If you want to set the webhook manually, you can use the following URL:

Note: Replace <YourTelegramBotToken> with your bot token and <APP_URL> with your app URL in the .env file.

III. Add chat IDs you want to receive notifications to the .env file

1. Add multiple chat IDs to the .env file.

These chat IDs will be the chat IDs of your groups, channels, or users.

Also, you can add the chat ID of this bot to receive incoming notifications for itself.

2. Add a topic for supergroups with premium users (Thread ID)

You can add topic for supergroups with premium users (Thread ID).

These topics will be the topics of your supergroups.

3. Add multiple topics for supergroups with premium users (Thread IDs)

You can add multiple topics for each supergroup with premium users (Thread IDs).

Note:

  • Please use semicolon ";" to separate chat ids
    • And use a colon ":" to separate chat ID and topic
    • And use the comma "," if you want to add multiple topics

Now your configuration is complete. And the .env file will be like this:

🚀 Usage

Now you can send a message to your bot, and you will receive a welcome message from the bot.

If you want to check the menu, you can send the following message to your bot.

🎊 At this point, the configuration process for your telegram bot is completed. You can use all the features of this bot. 🎉🎉

Menu features of this bot

To increase ease of use. Let's create a menu with a list of commands listed for you.

Please send the following message to your bot to create a menu button.

Set menu Set menu

Now you will need to add the Webhook for your GitHub and GitLab repository to receive notifications.

📌 Add webhook on your GitHub repository to receive notifications

  1. Go to your repository settings.
  2. Go to the Webhooks section.
  3. Click on Add webhook.
  4. Set Payload URL to <APP_URL>.
  5. Set Content type to application/x-www-form-urlencoded.
  6. Which events would you like to trigger this webhook? Select Let me select individual events..
  7. Click on the Active checkbox and Add webhook button.
  8. Done. You will receive a notification when your repository has a new event.

Here is the first notification you will receive:

Github ping event notification

📌 Add a webhook on your GitLab repository to receive notifications

  1. Go to your repository settings.
  2. Go to the Webhooks section.
  3. Click on Add new webhook.
  4. Set URL to <APP_URL>.
  5. Choose any Trigger you want.
  6. Click on the Enable SSL verification checkbox and Add webhook button.

Note: You can set up this webhook for different repositories. Please similarly set up the webhook for each repository.

Then every time one of those repositories appears an event, this telegram bot will immediately send you a notification.

All versions of telegram-bot-github-notify with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-json Version *
cslant/telegram-git-notifier Version ^1.3.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package lbiltech/telegram-bot-github-notify contains the following files

Loading the files please wait ....