Skip to content

Commit

Permalink
CatUB GITBOOK-37: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
TheWeaver786 authored and gitbook-bot committed May 7, 2023
1 parent cabb367 commit db6f4c2
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 15 deletions.
12 changes: 0 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,6 @@ description: >-

# 📙 Introduction

<div>

<figure><img src=".gitbook/assets/catlogo.jpg" alt="Cat Logo" width="280"><figcaption><p>Vidushano</p></figcaption></figure>



<figure><img src=".gitbook/assets/catlogo3.jpg" alt="" width="563"><figcaption><p>mRr_LaKsH</p></figcaption></figure>



<figure><img src=".gitbook/assets/catlogo2.jpg" alt=""><figcaption></figcaption></figure>

</div>

Catuserbot has been developed using Python programming language and Telethon MTProto, a client library for the Telegram API that provides a secure and reliable way to interact with the Telegram platform.
2 changes: 1 addition & 1 deletion docs/installation/hosting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Its better if you run on VPS or any hosting platform over hosting locally, so it

## ≡ Methods to Host CatUserBot

<table data-view="cards"><thead><tr><th></th><th></th><th data-type="rating" data-max="5"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><em><mark style="color:blue;"><strong>Docker Compose</strong></mark></em></td><td><em>Host your bot using docker-compose</em></td><td>5</td><td><a href="docker-compose.md">docker-compose.md</a></td><td><a href="../../.gitbook/assets/2982327.jpg">2982327.jpg</a></td></tr><tr><td><em><mark style="color:blue;"><strong>Self Host</strong></mark></em></td><td><em>Host your bot manually by local hosting</em></td><td>3</td><td><a href="self-host.md">self-host.md</a></td><td><a href="../../.gitbook/assets/5089337.jpg">5089337.jpg</a></td></tr><tr><td><em><mark style="color:blue;"><strong>Heroku</strong></mark></em></td><td><em>Host your bot in hosting platform heroku</em></td><td>3</td><td><a href="heroku.md">heroku.md</a></td><td><a href="../../.gitbook/assets/heroku.jpg">heroku.jpg</a></td></tr><tr><td><em><mark style="color:blue;"><strong>Railway</strong></mark></em></td><td><em>Get SSH of Railway &#x26; host there</em></td><td>null</td><td><a href="railway.md">railway.md</a></td><td><a href="../../.gitbook/assets/logo-light.png">logo-light.png</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th data-type="rating" data-max="5"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><em><mark style="color:blue;"><strong>Docker Compose</strong></mark></em></td><td><em>Host your bot using docker-compose</em></td><td>5</td><td><a href="docker-compose.md">docker-compose.md</a></td><td><a href="../../.gitbook/assets/2982327.jpg">2982327.jpg</a></td></tr><tr><td><em><mark style="color:blue;"><strong>Self Host</strong></mark></em></td><td><em>Host your bot manually by local hosting</em></td><td>3</td><td><a href="self-host.md">self-host.md</a></td><td><a href="../../.gitbook/assets/5089337.jpg">5089337.jpg</a></td></tr><tr><td><em><mark style="color:blue;"><strong>Heroku</strong></mark></em></td><td><em>Host your bot in hosting platform heroku</em></td><td>3</td><td><a href="heroku.md">heroku.md</a></td><td><a href="../../.gitbook/assets/heroku.jpg">heroku.jpg</a></td></tr><tr><td><em><mark style="color:blue;"><strong>Railway</strong></mark></em></td><td><em>Get SSH of Railway &#x26; host there</em></td><td>4</td><td><a href="railway.md">railway.md</a></td><td><a href="../../.gitbook/assets/logo-light.png">logo-light.png</a></td></tr></tbody></table>
30 changes: 29 additions & 1 deletion docs/installation/hosting/docker-compose.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# 📕 Docker Compose

{% hint style="success" %}
This the easiest and recommended method to host Cat Userbot.
{% endhint %}

## ≡ Run your bot in docker with just simple steps

### _**Install required packages**_ <a href="#install-packages" id="install-packages"></a>
Expand All @@ -14,7 +18,7 @@ sudo apt install --no-install-recommends -y git docker-compose

{% code title="Change dir to catuserbot & make config.py to save config values" overflow="wrap" %}
```batch
git clone -b beta https://github.com/TgCatUB/catuserbot && cd catuserbot && mv exampleconfig.py config.py
git clone https://github.com/TgCatUB/catuserbot && cd catuserbot && mv exampleconfig.py config.py
```
{% endcode %}

Expand All @@ -29,3 +33,27 @@ git clone -b beta https://github.com/TgCatUB/catuserbot && cd catuserbot && mv e
* _**Run detached:**_ `sudo docker-compose up -d`
* _**Stop:**_ `sudo docker-compose stop`
* _**Check:**_ `sudo docker-compose ps`

{% hint style="info" %}
Whenever there is an update to our base docker image (will be notified via the channel or support group), use the below steps to update your docker instances. This is not part of the main guide or not a method to update the Bot.
{% endhint %}

### _Steps to update base docker image**.**_ <a href="#run-bot" id="run-bot"></a>

{% code title="stop the running containers " overflow="wrap" %}
```batch
sudo docker-compose stop
```
{% endcode %}

{% code title="pull the latest image from hub" overflow="wrap" %}
```batch
sudo docker pull catub/core:bullseye
```
{% endcode %}

{% code title="build and run with latest image" overflow="wrap" %}
```batch
sudo docker-compose up --build
```
{% endcode %}
2 changes: 1 addition & 1 deletion docs/installation/hosting/self-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ sudo apt update && sudo apt upgrade -y \

{% code title="Change dir to catuserbot & make config.py to save config values" overflow="wrap" %}
```batch
git clone -b beta https://github.com/TgCatUB/catuserbot && cd catuserbot && mv exampleconfig.py config.py
git clone https://github.com/TgCatUB/catuserbot && cd catuserbot && mv exampleconfig.py config.py
```
{% endcode %}

Expand Down

0 comments on commit db6f4c2

Please sign in to comment.