Lawnchair's main community is located on Telegram, discussions happen, stable builds get posted, Travis CI builds get posted etc. Besides Telegram though, Lawnchair also has a thread on XDA-Developers. And as it turns out, some people don't use Telegram and don't want to use it either, which is fine. They're missing out on the Travis CI builds though, since those can happen very frequently and it would be a hassle to post all of them on XDA. That's where this bot comes into play.
These instructions assume you're using a Debian-based GNU/Linux distribution.
- Install Python 3.4 and pip (Any Python 3 version is fine, really)
sudo apt-get install python3.4 python3-pip python3-virtualenv- Create a virtualenv for this bot
mkdir -p ~/virtualenvs && cd ~/virtualenvs && virtualenv -p python3 telegram-lawnchair-mirror- Activate the virtualenv
. ~/virtualenvs/telegram-lawnchair-mirror/bin/activate- Install the required pip modules
pip3 install pyTelegramBotAPI requests- Clone this repository using the following command
git clone [email protected]:YBinnenweg/telegram-lawnchair-mirror.git- Enter the repository folder
cd telegram-lawnchair-mirror- Copy the default configuration file
cp config.cfg.default config.cfg- Fill out the config file, the required options are listed here
API_KEY: keyhere
The Python bot needs this API key in order to talk to Telegram. Don't have an API key? Have a look at this guide by Telegram to set up a bot.
DOWNLOAD_DIR: downloads/
The directory where downloads will be stored (make sure the user you're running the bot as has write permissions!). This path has to be the full path to the directory (ie. /home/user/telegram-bot/files/downloads/).
LOG_DIR: logs/
The directory where the logs will be stored (make sure the user you're running the bot as has write permissions!).
ALLOWED_CHANNELS: -1000000000
The id of a channel that is allowed to mirror files via this bot. The id will be printed on-screen when it is being denied.
Run the following command
python3 bot.pyThe bot should now be up & running! :) It's recommended you try it out at this stage. Once you're confident it's properly working, move on!
In order to properly run the bot we're going to set up a systemd service file so that we can run the bot that way:
- Copy the service template from the misc folder to
/etc/systemd/system/lawnchairmirror.service
sudo cp misc/lawnchairmirror.service /etc/systemd/system/lawnchairmirror.service- Replace the following variables with the correct information:
- PATH_TO_WORKING_DIRECTORY: The working directory the service will use. I'd recommend you set this to the repository directory (ie.
/home/lawnchairmirror/telegram-lawnchair-mirror) - USERNAME: The username of the user the bot should run as
- GROUP: The group of the user the bot should run as
- PATH_TO_HOMEDIR: The path to the homedir of the user that the bot will run as
- PATH_TO_DOWNLOAD_DIR: The path to the directory where you will store your downloads (the directory you set earlier in the
config.cfgfile) - PATH_TO_VIRTUALENV_PYTHON: The path to the
python3binary in your virtualenv - PATH_TO_BOT.PY: The path to the
bot.pyfile
- Tell systemd you want to load the new service file we just created:
sudo systemctl daemon-reload- Start the service:
sudo systemctl start lawnchairmirror.serviceYou should now check if the bot is running properly, you can do this in multiple ways, these are the two I recommend:
1. `sudo systemctl status lawnchairmirror.service`
2. `ps aux | grep python3` or `ps aux | grep bot.py`
After you've verified the bot is running properly, you can set the service to load when your server starts!
- Enable the service at boot:
sudo systemctl enable lawnchairmirror.serviceThe bot should now be running and automatically start when your system reboots! In addition to that the Restart=always line in the lawnchairmirror.service file ensures the bot is restarted in case it crashes (which may happen due to network issues for example).
- Create a separate user with as few privileges as possible to run the bot as. This ensures that if the bot somehow gets compromised, your own personal user is not affected, and the damage is as limited as possible.
- Set up the bot in such a way that it writes to a directory, which is the documentroot for a site at the same time. If you then also enable directory listing in your virtualhost/server block, the files you're mirroring are automatically available via HTTPS!
Kinda :/
Everything before commit b3b282cbd85c1fd1a049c045da3f2d2dfa2776a5 can be used to mirror any channel. The changes after that include Lawnchair-specific changes for parsing the changelog for example. They're not too hard to adjust/rip out though! :)
Potatoes. Show me you can do it better.