docs: Extract advanced usage, add proxy info
This commit is contained in:
parent
226713a5a0
commit
7195a05890
4 changed files with 52 additions and 20 deletions
BIN
docs/_static/auth.png
vendored
Normal file
BIN
docs/_static/auth.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 26 KiB |
40
docs/advanced.rst
Normal file
40
docs/advanced.rst
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
==============
|
||||||
|
Advanced usage
|
||||||
|
==============
|
||||||
|
|
||||||
|
Disabling HTTPS
|
||||||
|
---------------
|
||||||
|
|
||||||
|
You may pass the ``--disable-https`` flag to use unencrypted HTTP instead of
|
||||||
|
HTTPS for a given instance. This is inherently insecure and should be used only
|
||||||
|
when connecting to local development instances.
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
toot login --disable-https --instance localhost:8080
|
||||||
|
|
||||||
|
Using proxies
|
||||||
|
-------------
|
||||||
|
|
||||||
|
You can configure proxies by setting the ``HTTPS_PROXY`` or ``HTTP_PROXY``
|
||||||
|
environment variables. This will cause all http(s) requests to be proxied
|
||||||
|
through the specified server.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
export HTTPS_PROXY="http://1.2.3.4:5678"
|
||||||
|
toot login --instance mastodon.social
|
||||||
|
|
||||||
|
**NB:** This feature is provided by
|
||||||
|
`requests <http://docs.python-requests.org/en/master/user/advanced/#proxies>`_
|
||||||
|
and setting the environment variable will affect other programs using this
|
||||||
|
library.
|
||||||
|
|
||||||
|
This environment can be set for a single call to toot by prefixing the command
|
||||||
|
with the environment variable:
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
HTTPS_PROXY="http://1.2.3.4:5678" toot login --instance mastodon.social
|
|
@ -14,16 +14,6 @@ toot is a commandline tool for interacting with Mastodon social networks.
|
||||||
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
|
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
|
||||||
:target: https://pypi.python.org/pypi/toot
|
:target: https://pypi.python.org/pypi/toot
|
||||||
|
|
||||||
Contents
|
|
||||||
--------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
install
|
|
||||||
usage
|
|
||||||
release
|
|
||||||
|
|
||||||
Features
|
Features
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
@ -31,7 +21,18 @@ Features
|
||||||
* Support for media uploads, spoiler text, sensitive content
|
* Support for media uploads, spoiler text, sensitive content
|
||||||
* Search by account or hash tag
|
* Search by account or hash tag
|
||||||
* Following, muting and blocking accounts
|
* Following, muting and blocking accounts
|
||||||
* Simple swithcing between authenticated in Mastodon accounts
|
* Simple switching between multiple Mastodon accounts
|
||||||
|
|
||||||
|
Contents
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
install
|
||||||
|
usage
|
||||||
|
advanced
|
||||||
|
release
|
||||||
|
|
||||||
Curses UI
|
Curses UI
|
||||||
---------
|
---------
|
||||||
|
|
|
@ -58,15 +58,6 @@ You will be redirected to your Mastodon instance to log in and authorize toot to
|
||||||
|
|
||||||
The application and user access tokens will be saved in the configuration file located at ``~/.config/toot/instances/config.json``.
|
The application and user access tokens will be saved in the configuration file located at ``~/.config/toot/instances/config.json``.
|
||||||
|
|
||||||
Disabling HTTPS
|
|
||||||
~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
You may pass the ``--disable-https`` flag to use unencrypted HTTP instead of HTTPS for a given instance. This is inherently insecure and should be used only when connecting to local development instances.
|
|
||||||
|
|
||||||
.. code-block:: sh
|
|
||||||
|
|
||||||
toot login --disable-https --instance localhost:8080
|
|
||||||
|
|
||||||
Using multiple accounts
|
Using multiple accounts
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue