Skip to content

Commit

Permalink
Add Docker instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
agneevX authored Nov 3, 2022
1 parent 96bb8ba commit 1b6edcc
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,22 @@ This bot utilises two libraries (credit to the creators)
1. Telethon
2. Unalix

#### Usage,
#### Usage

1. Send a link and the bot will reply with a clean URL
2. Add the bot in a group and the bot will reply with clean URLs there

##### Deploy your own bot,
1. Follow this [guide](https://docs.telethon.dev/en/stable/basic/signing-in.html "setup guide") to get `api_id`, `api_hash` and `bot_token`
2. Replace those values in `CONFIG.py`
3. Create a virtualenv and install the `requirements.txt`
4. Start the bot, `python main_file.py`
##### Self-host

```
git clone https://github.com/agneevX/url-cleaner-bot
cd url-cleaner-bot
```

- Follow this [guide](https://docs.telethon.dev/en/stable/basic/signing-in.html "setup guide") to get `api_id`, `api_hash` and `bot_token`
- Replace those values in `CONFIG.py`

```
docker build . -t url-cleaner-bot
docker run -d url-cleaner-bot
```

0 comments on commit 1b6edcc

Please sign in to comment.