Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
skeledrew committed Mar 25, 2018
1 parent 8c576b4 commit c12c34d
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.rst
Expand Up @@ -28,7 +28,7 @@ Remote Access Tool Over Telegram
Description
-----------

Have you ever wanted to remotedly access your personal computer or server? Have you ever wanted to do it without setting up port forwarding or otherwise making your computer accessible to the world? How about without using a solution such as Teamviewer (of which I've been a faithful user for years), which only provides a graphical interface, making it very suseptible to bad connections and will also eat mobile data for lunch?
Have you ever wanted to remotedly access your personal computer or server? Have you ever wanted to do it without setting up port forwarding or otherwise making your computer accessible to the world? How about without using a solution such as *Teamviewer* (of which I've been a faithful user for years), which only provides a graphical interface, making it very suseptible to bad connections and will also eat your mobile data for lunch?

Enter RAToT, a tool to allow access to Bash (and eventually other command line oriented apps) using a Telegram messenger app. Written in Python, it leverages the Telegram bot platform to bridge the gap between a remote machine, and whatever device you have at hand that can run a Telegram client, phone, PC, browser-only machine, etc. Just use as if you're chatting with someone.

Expand All @@ -50,31 +50,31 @@ Installation

2) Clone from this repo or your own fork.

3) Setup and activate a virtualenv for the project. The author recommends `pyenv`.
3) Setup and activate a virtualenv for the project. I recommend *pyenv*.

4) Install the requirements (and optionally requirements_dev).

5) Patch the following files in your Python's site-packages folder:

a) In pexpect/__init__.py add ``import replwrap`` (issue possibly already fixed in latest pexpect version)
a) In **pexpect/__init__.py** add ``from . import replwrap``

b) In rpyc/__init__.py add ``from rpyc.utils import server``
b) In **rpyc/__init__.py** add ``from rpyc.utils import server``

6) Copy the .env.template file to .env
6) Copy the **.env.template** file to **.env**

7) Visit the BotFather in your Telegram, create a bot and copy the token.

8) Add the bot token and other information to your .env:
8) Add the bot token and other information to your **.env**:

* ``$ dotenv set TOKEN your-bot-token``

* ``$ dotenv set ADMINS your-telegram-username`` (set one if needed in your profile)

* You may also change the HOST and PORT if you wish and know what you're doing.

* NB: If you get the message `It seems python-dotenv is not installed with cli option.` do ``pip install python-dotenv[cli]``
* NB: If you get the message *It seems python-dotenv is not installed with cli option.*, do ``$ pip install python-dotenv[cli]``

9) Start the server and router bot on your machine:
9) Start both the server and router bot on your machine:

a) ``$ cd ratot``

Expand All @@ -92,9 +92,9 @@ Installation

c) Add to the .env as API_ID and API_HASH.

d) Add your registered phone numer as PHONE; format `+1234567890`.
d) Add your registered phone numer as PHONE; format *+1234567890*.

e) Optionally change the efault SESSION_NAME.
e) Optionally change the default SESSION_NAME.

f) Run client with ``$ ./telewrap.py`` (ACTUALLY DON'T DO THIS; CURRENTLY INCOMPLETE & BROKEN)

Expand All @@ -106,7 +106,7 @@ TODO

* Bring client to working state

* Fix broken repo things
* Fix Travis and other broken repo things

* Make a patcher

Expand All @@ -122,6 +122,8 @@ TODO
Credits
---------

See AUTHORS.rst for listing.

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
Expand Down

0 comments on commit c12c34d

Please sign in to comment.