diff --git a/docs/_static/bridges/destroy.png b/docs/_static/bridges/destroy.png new file mode 100644 index 0000000..a95e58d Binary files /dev/null and b/docs/_static/bridges/destroy.png differ diff --git a/docs/_static/bridges/edit.png b/docs/_static/bridges/edit.png new file mode 100644 index 0000000..9c6e327 Binary files /dev/null and b/docs/_static/bridges/edit.png differ diff --git a/docs/_static/bridges/list.png b/docs/_static/bridges/list.png new file mode 100644 index 0000000..c8505f8 Binary files /dev/null and b/docs/_static/bridges/list.png differ diff --git a/docs/_static/logo-gp.png b/docs/_static/logo-gp.png new file mode 100644 index 0000000..f2a3cbb Binary files /dev/null and b/docs/_static/logo-gp.png differ diff --git a/docs/_static/logo-otf.png b/docs/_static/logo-otf.png new file mode 100644 index 0000000..d1e34d4 Binary files /dev/null and b/docs/_static/logo-otf.png differ diff --git a/docs/_static/logo-tor.png b/docs/_static/logo-tor.png new file mode 100644 index 0000000..642cb29 Binary files /dev/null and b/docs/_static/logo-tor.png differ diff --git a/docs/index.rst b/docs/index.rst index d83eddc..f118089 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,8 +31,49 @@ Documentation Home Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +Maintained by +------------- + ++------------+----------------------------------------------------+ +| |logo-gp| | `Guardian Project `_ | ++------------+----------------------------------------------------+ + +Developed by +------------ + ++------------+----------------------------------------------------+ +| |logo-gp| | `Guardian Project `_ | ++------------+----------------------------------------------------+ +| |logo-tor| | `Tor Project `_ | ++------------+----------------------------------------------------+ + +Supported by [*]_ +----------------- + ++------------+--------------------------------------------------+ +| |logo-otf| | `Open Technology Fund `_ | ++------------+--------------------------------------------------+ + + + +.. |logo-gp| image:: /_static/logo-gp.png + :height: 50 + :alt: Guardian Project + +.. |logo-tor| image:: /_static/logo-tor.png + :height: 50 + :alt: Tor Project + +.. |logo-otf| image:: /_static/logo-otf.png + :width: 146 + :alt: Open Technology Fund + +.. rubric:: Footnotes + +.. [*] Support received does not imply endorsement. \ No newline at end of file diff --git a/docs/user/bridges.rst b/docs/user/bridges.rst index 64be6d3..3855e0f 100644 --- a/docs/user/bridges.rst +++ b/docs/user/bridges.rst @@ -6,16 +6,71 @@ uniformly configured and expendable. For this reason the only configuration that with the management of individual resources taking place through the automation subsystem. Once your administrator has provided you access to the portal, you can begin to configure your Tor Bridge deployments. +To get started, select "Tor Bridges" under "Configuration" from the menu on the left hand side. If you are using a +mobile device, you may need to click the hamburger icon at the top of the screen to open the menu. + +.. image:: /_static/bridges/list.png + :width: 800 New Configuration ----------------- -.. image:: /_static/bridges/new.png +To create a new configuration, click "Create new configuration" at the top of the configuration list. This will present +you with the new configuration form: +.. image:: /_static/bridges/new.png + :width: 800 + +Provider +"""""""" + +The provider that the bridges should be deployed to. Your administrator must have configured this provider before any +resources will be deployed. + +Distribution Method +""""""""""""""""""" + +The distribution method for `BridgeDB `_. +Unless you have specific requirements you will likely choose either "Any" to allow for BridgeDB to allocate the bridge +to where it is most needed, or "None" to have a bridge that is not distributed by BridgeDB for you to distribute +directly to the end-user via another channel. + +Description +""""""""""" + +A free-form text description to help identify the collection. + +Group +""""" + +The group the collection belongs to. + +Number +"""""" + +The number of bridges to deploy. When editing, increasing or decreasing this number will cause new bridges to be +created, or existing bridges to be destroyed, so that the number deployed will match this number. Edit Configuration ------------------ +.. image:: /_static/bridges/edit.png + :width: 800 + +See the "New Configuration" section above for the descriptions of each field. + Destroy Configuration --------------------- +.. image:: /_static/bridges/destroy.png + :width: 800 + +When destroying a configuration, the bridges deployed for that configuration will be automatically destroyed with it. + +Bridge Rotation +--------------- + +If not using an automated block detection and replacement system, bridges can be manually replaced as needed. +When viewing the bridge list, either while editing the configuration or the full list of bridges, select "Mark as +blocked". +The bridge will be replaced on the next automation run.