> For the complete documentation index, see [llms.txt](https://hellbot-docs.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hellbot-docs.gitbook.io/docs/hellbot-userbot/deploy-locally.md).

# Deploy Locally

A guide to host HellBot Userbot locally.

{% embed url="<https://github.com/The-HellBot/HellBot>" %}
Official HellBot Userbot Repo
{% endembed %}

> Need python version >=3.10

### Steps to deploy locally:

* Fork & Star this [repo.](https://github.com/The-HellBot/HellBot)
* Now, follow these steps carefully:
  * Update apt:

    *<mark style="color:purple;">`sudo apt update && sudo apt upgrade -y`</mark>*
  * Now install required packages:

    *<mark style="color:purple;">`sudo apt install --no-install-recommends -y python3-lxml python3-psycopg2 libpq-dev libcurl4-openssl-dev libxml2-dev libxslt1-dev python3-pip python3-sqlalchemy openssl wget curl git libffi-dev libjpeg-dev libwebp-dev python3 python3-dev pv tree mediainfo nano nodejs libreadline-dev libyaml-dev gcc zlib1g ffmpeg libssl-dev libgconf-2-4 libxi6 unzip libopus0 libopus-dev python3-virtualenv tmux libmagickwand-dev`</mark>*
  * Clone the GitHub repo:

    *<mark style="color:purple;">`git clone https://github.com/The-HellBot/Plugins-T`</mark>*
  * Go to the cloned repo directory:

    *<mark style="color:purple;">`cd Plugins-T`</mark>*
  * Edit the config file:

    *<mark style="color:purple;">`mv ex_config.py config.py`</mark>*

    *<mark style="color:purple;">`nano config.py`</mark>*

    Fill all the mentioned variables there. Refer to [this page](/docs/hellbot-userbot/config-variables.md#mandatory-variables) for easier understanding.
  * Enter in new window:

    *<mark style="color:purple;">`tmux`</mark>*
  * Create and activate a new virtualenv:

    *<mark style="color:purple;">`virtualenv venv`</mark>*

    *<mark style="color:purple;">`source venv/bin/activate`</mark>*
  * Install requirements to run the userbot:

    *<mark style="color:purple;">`pip3 install -r requirements.txt`</mark>*
  * After requirements are installed, start the userbot:

    *<mark style="color:purple;">`bash start.sh`</mark>*
  * Exit the window:

    *<mark style="color:purple;">**`CTRL + B`**</mark>*  *then*  *<mark style="color:purple;">**`D`**</mark>*

*<mark style="color:orange;">**Enjoy your Userbot**</mark>* :tada:
