194 lines
14 KiB
Markdown
194 lines
14 KiB
Markdown
# TG-Index Deploy Guide (Repl.it)
|
|
|
|
Replit is a good place if you want to host your small sized projects and code in real-time. This guide will walk you through the process of deploying tg-index on Replit, a Python web app to index telegram channels and serve their files to download.
|
|
|
|
**NOTE : THIS GUIDE IS MADE FOR BEGINNERS LIKE PEOPLE WHO KNOW VERY LITTLE ABOUT GITHUB, REPLIT OR ANYTHING RELATED TO THIS PROJECT.**
|
|
|
|
> There's a limitation with the free version of Replit that free repls stop running automatically after a few minutes of inactivity (no traffic), it is very frustrating since web apps need to stay online 24/7 or they're useless. GOOD NEWS! for those who can't purchase or don't want to purchase the paid version, I'll introduce you to a method by which you can stop the repl from falling asleep and keep your web app online as long as possible. THANK YOU `rayanfer32` on GitHub for introducing this method.
|
|
|
|
NOW LET'S GET INTO BUSINESS ~
|
|
|
|
## [1] Fork The Repository On Github
|
|
|
|
It is always a good practice to make a fork of the project repo before you do anything else or instead of deploying directly from the parent repo, since any update on the parent repository will also affect your app, so this might break its stability so making a repository beforehand will save you the pain of losing the version of code that was used to deploy your app. Also, anything might happen to the parent repo or the repo owner account, so you want to ensure that the source code of your app remains intact and secure.
|
|
|
|
- So click on the `Fork` button on the upper right corner of the repository page. This will make a copy of the current state of the source code on your GitHub account, any update on the main reposiory will not affect your forked version unless you manually choose to merge them.
|
|
|
|
**You will have to move all the files from the `repl-config` folder to the root folder for the following steps to work.**
|
|
|
|
|
|
|
|
## [2] Create A Replit Account
|
|
|
|
Go to <https://replit.com/signup> and create a free Replit account.
|
|
|
|
> One thing to note is that the username you use while creating a Replit account will later be used as your subdomain alias on all of your web apps, say you put `elon_musk` as your username, then the domain of your web apps will be like <https://appname.elon_musk.repl.co>.
|
|
|
|
## [3] Connect Your Github Account With Your Replit Account
|
|
|
|
- Click on the `New repl` button on upper left side of the dashboard. Then on the little window that pops up, **Import from GitHub** >> **Authorize GitHub to import your repos**.
|
|
|
|
|
|
|
|
|
|
- Then select the fork of the tg-index repo that you made earlier.
|
|
|
|
|
|
|
|
- After, Replit will automatically clone the repo from your GitHub fork and detect its language. It may take a few seconds to finish this initialization process and after which, your Replit window should look similar to this ~
|
|
|
|
|
|
|
|
> NOTE : IF YOU ALREADY HAVE A REPLIT ACCOUNT AND WANT TO DEPLOY DIRECTLY FROM THE PARENT REPO, [CLICK HERE](https://repl.it/github/odysseusmax/tg-index). IT WILL CLONE THE REPOSITORY DIRECTLY FROM THE PARENT REPO.
|
|
|
|
## [4] Set The Required Environment Variables
|
|
|
|
- Open the `Secrets (Environment variables)` tab from the left sidebar, here you'll be able to add all the environment variables needed for your app.
|
|
|
|
|
|
|
|
|
|
- Now add the required environment variables that your app needs to run one by one. Environment variables can be found [here](../README.md#deploy-guide)
|
|
|
|
|
|
|
|
- There are actually 4 required variables for tg-index, the fourth one is a session string of your account which we will generate inside our app. So after setting the `API_ID`, `API_HASH` and `INDEX_SETTINGS` variable properly, click on the 'Run' button.
|
|
|
|
|
|
|
|
- When running the repl for the first time, Replit will download and install all the third party packages (dependencies) needed for your app to work, so it may take a while for the process to complete. After that, a script that checks if all the required variables are present will run and when it finds that we didn't set the `SESSION_STRING` variable, it will trigger another built-in script that will ask you to type your phone number or bot API token. **TG-INDEX DOES NOT SUPPORT INDEXING CHANNELS/GROUPS USING BOTS YET** so you must type your phone number **with country code** and hit enter.
|
|
|
|
> NOTE : IT DOES NOT HAVE TO BE THE SAME PHONE NUMBER YOU USED TO GET THE `API_ID` AND `API_HASH` VALUES, IT IS THE PHONE NUMBER OF THE ACCOUNT OF WHICH YOU WANT TO FETCH THE CHANNELS AND GROUPS FROM. SO IT GOES WITHOUT SAYING THAT, IF YOU WANT TO INDEX A SPECIFIC CHANNEL/GROUP, THE ACCOUNT LINKED WITH THE PHONE NUMBER YOU ARE TYPING HERE NEEDS TO BE A SUBSCRIBER/MEMBER OF THAT CHANNEL/GROUP.
|
|
> NOTE : THE CHECKER SCRIPT WILL TRIGGER THE SESSION STRING GENERATOR SCRIPT ONLY IF YOU SET THE PREVIOUS THREE VARIABLES PROPERLY OR ELSE IT WILL ASK YOU TO SET THE MISSING VARIABLES INSTEAD.
|
|
|
|
|
|
|
|
- After that, you'll get a private message from Telegram containing an OTP, type that OTP on the console and hit enter. If the OTP is correct, a long piece of random letters and symbols will appear on your console. COPY THAT and set it as an environment varible named `SESSION_STRING` like the other three.
|
|
|
|
- THEN, RUN THE REPL AGAIN.
|
|
|
|
- If you did everything up to this point correctly, a preview window similar to this should appear above your console ~
|
|
|
|
|
|
|
|
## [5] Customize What To Index
|
|
|
|
- Open the `Secrets (Environment variables)` sidebar again and edit the `INDEX_SETTINGS` variable to your need. The general format is ~
|
|
|
|
> NOTE : EVERY TIME YOU ADD A NEW VARIABLE OR EDIT AN EXISTING VARIABLE, YOU MUST STOP AND RESTART YOUR REPL IF IT'S ALREADY RUNNING.
|
|
> NOTE : USING THESE EXACT SAME SETTINGS WILL ALLOW YOUR APP TO FETCH ALL OF YOUR PUBLIC AND PRIVATE CHANNELS. IT WON'T INDEX YOUR PUBLIC/PRIVATE GROUPS AND PRIVATE CHATS WITH PEOPLES/BOTS
|
|
|
|
```json
|
|
{
|
|
"index_all": true,
|
|
"index_private": false,
|
|
"index_group": false,
|
|
"index_channel": true,
|
|
"exclude_chats": [],
|
|
"include_chats": []
|
|
}
|
|
```
|
|
|
|
> NOTE : `INDEX_SETTINGS` IS A REQUIRED VARIABLE SO, ALL THE SUB-VARIABLES OF `INDEX_SETTINGS` MENTIONED BELOW ARE ALSO REQUIRED VARIABLES.
|
|
|
|
| Variable Name | Description |
|
|
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `index_all` | Whether to consider all the chats associated with the Telegram account. Value should either be `true` or `false`. |
|
|
| `index_private` | Whether to index private chats. Only considered if `index_all` is set to `true`. Value should either be `true` or `false`. |
|
|
| `index_group` | Whether to index group chats. Only considered if `index_all` is set to `true`. Value should either be `true` or `false`. |
|
|
| `index_channel` | Whether to index channels. Only considered if `index_all` is set to `true`. Value should either be `true` or `false`. |
|
|
| `exclude_chats` | An array/list of chat id's that should be ignored for indexing. Only considered if `index_all` is set to `true`. Example : `"exclude_chats": [-123456789, -987654321, -147258369]` |
|
|
| `include_chats` | An array/list of chat id's to index. Only considered if `index_all` is set to `false`. Example : `"include_chats": [-123456789, -987654321, 147258369]` |
|
|
|
|
### Some `INDEX_SETTINGS` Examples
|
|
|
|
- If you want to only index the channel with the channel ID `-123456789`, then the value of your `INDEX_SETTINGS` variable should be ~
|
|
|
|
```json
|
|
{
|
|
"index_all": false,
|
|
"index_private": false,
|
|
"index_group": false,
|
|
"index_channel": true,
|
|
"exclude_chats": [],
|
|
"include_chats": [-123456789]
|
|
}
|
|
```
|
|
|
|
- If you want to index every public/private channel on your account except a channel with the channel ID `-123456789`, the value of your `INDEX_SETTINGS` variable should be ~
|
|
|
|
```json
|
|
{
|
|
"index_all": true,
|
|
"index_private": false,
|
|
"index_group": false,
|
|
"index_channel": true,
|
|
"exclude_chats": [-123456789],
|
|
"include_chats": []
|
|
}
|
|
```
|
|
|
|
- if you want to index every single chat, channel and group on your Telegram account, the value of your `INDEX_SETTINGS` variable should be ~
|
|
|
|
**WARNING!! IT IS NOT RECOMMENDED TO SET `INDEX_SETTINGS` VARIABLE TO INDEX EVERYTHING INCLUDING YOUR PRIVATE CHATS AS THEY WILL BE OPENLY AVAILABLE FOR EVERYONE TO SEE ON THE INTERNET. EVEN IF YOU WANT TO INDEX EVERYTHING, IT IS HIGHLY RECOMMENDED THAT YOU SET USERNAME & PASSWORD FOR YOUR INDEX. LEARN HOW TO DO THIS IN THE NEXT STEP.**
|
|
|
|
```json
|
|
{
|
|
"index_all": true,
|
|
"index_private": true,
|
|
"index_group": true,
|
|
"index_channel": true,
|
|
"exclude_chats": [],
|
|
"include_chats": []
|
|
}
|
|
```
|
|
|
|
## [6] Set Username & Password For Your Index (Optional)
|
|
|
|
- Just add these three environment variables in the "Secrets (Environment variables)" sidebar ~
|
|
|
|
| Variable Name | Description |
|
|
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `TGINDEX_USERNAME` | Username for authentication, defaults to `''`. |
|
|
| `PASSWORD` | Password for authentication, defaults to `''`. |
|
|
| `SECRET_KEY` | 32 characters long string for signing the session cookies, required if authentication is enabled. You can use [LastPass Password Generator](https://www.lastpass.com/password-generator) or any other password generator to generate a secure key. |
|
|
|
|
- Some optional variables for additional security to set while setting the login credentials are ~
|
|
|
|
| Variable Name | Description |
|
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
| `SESSION_COOKIE_LIFETIME` | Number of minutes, for which authenticated session is valid for, after which user has to login again. defaults to 60. |
|
|
| `BLOCK_DOWNLOADS` | Enable downloads or not. If any value is provided, download feature will be disabled. |
|
|
|
|
## [7] How To Keep Your Repl Online
|
|
|
|
So the biggest disadvantage of free repls is that they go offline after a few minutes (~5 minitues) of inactivity so what we need for your repl to keep active is a service that will keep sending a timely ping so that the repl doesn't fall asleep. UptimeRobot offers a free service that can do exactly that. Basically, it's a monitoring service that sends an HTTP request to your repl every 5 minutes to check whether your site is down and this checking process does the trick, so your repl stays online.
|
|
|
|
- Go to <https://uptimerobot.com/signUp> and create an account. Verify your email and login to your account.
|
|
|
|
> NOTE : IT IS RECOMMENDED THAT YOU USE AN EMAIL ADDRESS THAT YOU HAD SET UP ON YOUR MOBILE PHONE AS THE SERVICE WILL SEND YOU AN EMAIL TO THIS ADDRESS IF YOUR REPL GOES OFFLINE FOR SOME REASON.
|
|
|
|
- Your dashboard after login should look something similar to this ~
|
|
|
|
|
|
|
|
- Click on "Add New Monitor", and then from the "Monitor type" dropdown menu, select 'HTTP(s)'.
|
|
|
|
|
|
|
|
|
|
- Give this monitor a friendly name, copy your app URL from the box above the preview window of Replit and paste it in the "URL (or IP)" field of the monitor.
|
|
|
|
|
|
|
|
|
|
- Scroll down and click on "Create Monitor", and you're done setting up the monitoring service.
|
|
|
|
|
|
|
|
Again, thank you [@rayanfer32](https://github.com/rayanfer32) for introducing this amazing method, this is the biggest reason for making this guide.
|
|
|
|
THAT IS ALL!
|
|
|
|
**If you face any issue or something out of the ordinary while following this guide, drop me a word at [Telegram](https://tx.me/pseudokawaii). I'll try to help you if I'm not busy.**
|