Skip to content

Commit

Permalink
Added Heroku And Vps Deploy In Read Me
Browse files Browse the repository at this point in the history
  • Loading branch information
TechShreyash committed Feb 3, 2022
1 parent 0aaf0a6 commit 35f4760
Show file tree
Hide file tree
Showing 4 changed files with 239 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ README.md
downloads/
raw_files/
.gitignore
__pycache__/
__pycache__/
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ venv/
raw_files/
downloads/
__pycache__/
*.session-journal
*.session-journal
109 changes: 108 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,108 @@
<h4> This repo is just a clone of <a href="https://github.com/NotReallyShikhar/YukkiMusicBot">YukkiMusicBot</a>. All credits goes to devs of <a href="https://github.com/NotReallyShikhar/YukkiMusicBot/graphs/contributors">YukkiMusicBot</a>.</h4>
<h4>⚠️ This repo is just a clone of <a href="https://github.com/NotReallyShikhar/YukkiMusicBot">YukkiMusicBot</a>. All credits goes to devs of <a href="https://github.com/NotReallyShikhar/YukkiMusicBot/graphs/contributors">YukkiMusicBot</a>.</h4>

<p align="center"><img src="https://telegra.ph/file/e17f42bc195635b668d6d.jpg" alt="ICON" width="80%"/></p>

<h4 align="center">
A Telegram Music+video Bot written in Python using Pyrogram and Py-Tgcalls
</h4>
<p align="center">
<a href="https://t.me/SiestaXMusicBot"> Ready-To-Use Bot </a> •
<a href="https://notreallyshikhar.gitbook.io/yukkimusicbot/about/getting-started"> Documentation </a> •
<a href="https://t.me/TechZBots"> Support Channel </a> •
<a href="https://t.me/TechZBots_Support"> Support Chat </a>
</p>

# SiestaXMusic
A Powerful Telegram Music+Video Bot by which you can stream songs, videos and even live streams in your group calls via various sources. It comes with user friendly and easy to use yet elegant features.

## Deployment
Read [Docs](https://notreallyshikhar.gitbook.io/yukkimusicbot/deployment/requirements) for Detailed Description and Setup Guide on deploying Bot.

> Click on buttons to expand!
<details>
<summary><b>🔗 Requirements</b></summary>
<br>
- [Python3.9](https://www.python.org/downloads/release/python-390/)
- [Telegram API Key](https://docs.pyrogram.org/intro/setup#api-keys)
- [Telegram Bot Token](https://t.me/botfather)
- [MongoDB URI](https://telegra.ph/How-To-get-Mongodb-URI-04-06)
- [Pyrogram String Session](https://notreallyshikhar.gitbook.io/yukkimusicbot/deployment/string-session)

</details>

<details>
<summary><b>🔗 String Session</b></summary>
<br>

> You'll need a [API_ID](https://notreallyshikhar.gitbook.io/yukkimusicbot/vars/mandatory-vars#1.-api_id) & [API_HASH](https://notreallyshikhar.gitbook.io/yukkimusicbot/vars/mandatory-vars#2.-api_hash) in order to generate pyrogram session.
> Always remeber to use good API combo else your account could be deleted.
<h4> Generate Session via Repl: </h4>
<p><a href="https://replit.com/@NotReallyShikhar/Yukki-Music-String-Gen"><img src="https://img.shields.io/badge/Generate%20On%20Repl-blueviolet?style=for-the-badge&logo=appveyor" width="200""/></a></p>

<h4> Generate Session via Telegram StringGen Bot: </h4>
<p><a href="https://t.me/YukkiStringBot"><img src="https://img.shields.io/badge/TG%20String%20Gen%20Bot-blueviolet?style=for-the-badge&logo=appveyor" width="200""/></a></p>

</details>

<details>
<summary><b>🔗 Deploy to Heroku</b></summary>
<br>

> Heroku has two vars[ HEROKU_API_KEY & HEROKU_APP_NAME ] for Updater to work.
> By setting those two vars you can get logs of your heroku app, set var, edit var, delete vars , check dyno usage and update bot.
> Those two vars are not Mandatory! You can leave them blank too.
<h4>Click the button below to deploy Yukki on Heroku!</h4>
<p><a href="https://dashboard.heroku.com/new?template=https%3A%2F%2Fgithub.com%2FTechShreyash%2FSiestaXMusic"><img src="https://img.shields.io/badge/Deploy%20To%20Heroku-blueviolet?style=for-the-badge&logo=heroku" width="200"/></a></p>

</details>

<details>
<summary><b>🔗 Deploy to VPS</b></summary>
<br>

> Checkout [Docs](https://notreallyshikhar.gitbook.io/yukkimusicbot/deployment/local-hosting-or-vps) for Detailed Explanation on VPS Deploy

```console
shikhar@MacBook~ $ git clone https://github.com/TechShreyash/SiestaXMusic
shikhar@MacBook~ $ cd SiestaXMusic
shikhar@MacBook~ $ pip3 install -U -r requirements.txt
shikhar@MacBook~ $ cp sample.env .env
```
> Edit .env with your values and then start bot with
```console
shikhar@MacBook~ $ bash start
```

> Not Getting VPS Method? [Watch Tutorial](https://t.me/OfficialYukki/2275)
</details>
## Config Vars

- Checkout All [Available Vars](https://notreallyshikhar.gitbook.io/yukkimusicbot/vars/available-vars)
- Checkout Only [Mandatory Vars](https://notreallyshikhar.gitbook.io/yukkimusicbot/vars/mandatory-vars)
- Checkout Some [Configs](https://notreallyshikhar.gitbook.io/yukkimusicbot/setup-config/config)

## Contact & Support

- [Telegram Channel](https://t.me/TechZBots)
- [Telegram Support Group](https://t.me/TechZBots_Support)
- [Contact Owner](https://t.me/Tech_Shreyash)


## License

Distributed under the [GNU General Public License v3.0 License.](https://github.com/notreallyshikhar/YukkiMusicBot/blob/main/LICENSE) See `LICENSE.md` for more information.

## Acknowledgements

Special thanks to these amazing projects/people which/who help power Yukki Music Bot:

- [Pyrogram](https://github.com/pyrogram/pyrogram)
- [Py-Tgcalls](https://github.com/pytgcalls/pytgcalls)
- [CallsMusic Team](https://github.com/Callsmusic)
- [TheHamkerCat](https://github.com/TheHamkerCat)
- [Charon Baglari](https://github.com/XCBv021)
129 changes: 129 additions & 0 deletions app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
{
"name": "SiestaXMusic",
"description": "A Telegram Music Bot with proper functions written in Python with Pyrogram and Py-Tgcalls.",
"logo": "https://telegra.ph/file/70eacddcef7a56310cf70.jpg",
"keywords": [
"python3",
"telegram",
"bot",
"SiestaXMusic",
"telegram-bot",
"pyrogram"
],
"stack": "container",
"env": {
"API_ID": {
"description": "Get this value from https://my.telegram.org",
"value": "",
"required": true
},
"API_HASH": {
"description": "Get this value from https://my.telegram.org",
"value": "",
"required": true
},
"BOT_TOKEN": {
"description": "A Bot's token from Botfather",
"value": "",
"required": true
},
"DURATION_LIMIT": {
"description": "Duration Limit for Playout (In Mins).. Example: 60",
"value": "60",
"required": true
},
"ASSISTANT_PREFIX": {
"description": "Prefix for Assistant Commands.",
"value": ".",
"required": true
},
"MONGO_DB_URI": {
"description": "Mongo DB URL",
"value": "",
"required": true
},
"MUSIC_BOT_NAME": {
"description": "A name for your Music Bot.",
"value": "",
"required": true
},
"OWNER_ID": {
"description": "The user id(s) of user(s) whom you would like to add as a OWNER. Multiple values shall be seperated with a space.",
"value": "",
"required": true
},
"STRING_SESSION1": {
"description": "A Pyrogram String Session. One Assistant is Compulsory.",
"value": "",
"required": true
},
"STRING_SESSION2": {
"description": "A Pyrogram String Session. Leave blank if you dont want Multi-Assistant",
"value": "",
"required": false
},
"STRING_SESSION3": {
"description": "A Pyrogram String Session. Leave blank if you dont want Multi-Assistant",
"value": "",
"required": false
},
"STRING_SESSION4": {
"description": "A Pyrogram String Session. Leave blank if you dont want Multi-Assistant",
"value": "",
"required": false
},
"STRING_SESSION5": {
"description": "A Pyrogram String Session. Leave blank if you dont want Multi-Assistant",
"value": "",
"required": false
},
"HEROKU_API_KEY": {
"description": "Your Heroku account's API key",
"value": "",
"required": false
},
"HEROKU_APP_NAME": {
"description": "Your heroku app/bot's name",
"value": "",
"required": false
},
"LOG_GROUP_ID": {
"description": "Your Log Group ID, add your bot and promote as an admin with full rights!. Use only Group. Please don't use Channel ID.",
"value": "",
"required": true
},
"SUDO_USERS": {
"description": "The user id(s) of user(s) whom you would like to add as a SUDO. Multiple values shall be seperated with a space.",
"value": "",
"required": true
},
"THUMB_LINK": {
"description": "Telegraph image link of a image which you want to set as thumbnail.",
"value": "https://telegra.ph/file/e17f42bc195635b668d6d.jpg",
"required": true
},
"BOT_USERNAME": {
"description": "Your bot's username.",
"value": "",
"required": true
}
},
"buildpacks": [
{
"url": "heroku/python"
},
{
"url": "heroku/nodejs"
},
{
"url": "https://github.com/jonathanong/heroku-buildpack-ffmpeg-latest.git"
}
],
"formation": {
"worker": {
"quantity": 1,
"size": "free"
}
},
"stack": "container"
}

0 comments on commit 35f4760

Please sign in to comment.