tor-commits September 2018

tor-commits@lists.torproject.org

17 participants
3230 discussions

[sbws/master] Remove section to tor configuration page
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 41c42479aff51fc024434d7c8aa487a699156a40 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 14:05:24 2018 +0000 Remove section to tor configuration page --- docs/source/specification.rst | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/docs/source/specification.rst b/docs/source/specification.rst index fb2dd8c..3d870ef 100644 --- a/docs/source/specification.rst +++ b/docs/source/specification.rst @@ -89,23 +89,6 @@ Sbws uses the python library Stem_ to launch and control tor and the python library Requests_ to make HTTP(S) requests. Both are generally packaged for most major Linux distributions, and are always available in PyPI. -Configuring the sbws scanner -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -At the time of writing, sbws sets the following torrc options for the following -reasons when it launches Tor. You can find them in ``sbws/globals.py`` and -``sbws/util/stem.py``. - -- ``SocksPort auto``: To proxy requests over Tor. -- ``CookieAuthentication 1``: The easiest way to authenticate to Tor. -- ``LearnCircuitBuildTimeout 0``: To keep circuit build timeouts static. -- ``CircuitBuildTimeout 10``: To give up on struggling circuits sooner. -- ``UseEntryGuards 0``: To avoid path bias warnings. -- ``DataDirectory ...``: To set Tor's datadirectory to be inside sbws's. -- ``PidFile ...``: To make it easier to tell if Tor is running. -- ``ControlSocket ...``: To control Tor. -- ``Log notice ...``: To know what the heck is going on. - How it all works ----------------

1 0

[sbws/master] Rename title, add note about future specification
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit dea1bfc86f744979b8a2cbd1caddd5763e5b5a03 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 13:58:15 2018 +0000 Rename title, add note about future specification currently it contains more design and engineering details that specific algorithms of the components --- docs/source/specification.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/source/specification.rst b/docs/source/specification.rst index 0b76be5..fb2dd8c 100644 --- a/docs/source/specification.rst +++ b/docs/source/specification.rst @@ -1,11 +1,14 @@ -Simple Bandwidth Scanner Specification -====================================== +Simple Bandwidth Scanner technical details +============================================ -:Author: Matt Traudt +:Author: Matt Traudt, juga :Date: 29 March 2018 -:Last Update: 29 May 2018 +:Last Update: 19 Sep 2018 :Status: Draft +.. note:: this document may become an specification of the ``sbws`` method to + measure relays and/or scale the measuremensts + Conventions -----------

1 0

[sbws/master] Add contributing label
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 6e7b683be32ec123a620bc3be64f1031609204c9 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 14:55:48 2018 +0000 Add contributing label --- CONTRIBUTING.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ec8bdcc..d0806dd 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,3 +1,5 @@ +.. _contributing: + Contributing to Simple Bandwidth Scanner =========================================

1 0

[sbws/master] Add missing link
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 4c69f0cb1a701be9354a5f3dd4f29dcc8b3a654d Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 14:15:17 2018 +0000 Add missing link --- docs/source/specification.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/specification.rst b/docs/source/specification.rst index 3d870ef..e46782e 100644 --- a/docs/source/specification.rst +++ b/docs/source/specification.rst @@ -182,3 +182,4 @@ To support running in parallel with the legacy torflow_, **XXX Explain scaling** .. _torflow: https://gitweb.torproject.org/torflow.git .. _stem: https://stem.torproject.org .. _requests: https://docs.python-requests.org/ +.. _peerflow: https://www.nrl.navy.mil/itd/chacs/sites/www.nrl.navy.mil.itd.chacs/files/p… \ No newline at end of file

1 0

[sbws/master] Create sections for links to documentation
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 164cc7b4ef29f64e7089acffe0d6a95f40566208 Author: juga0 <juga(a)riseup.net> Date: Mon Sep 17 14:59:47 2018 +0000 Create sections for links to documentation --- README.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 38cb183..99466f0 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,35 @@ authorities or researches using a test Tor network, chutney or shadow. Please, do not run this software otherwise, since the measurements would not be used by Tor and would only create more traffic in the Tor network. -See ./INSTALL.rst) for install instructions, -[./DEPLOY.rst](./DEPLOY.rst) for deploy instructions, -[./CONTRIBUTING](./CONTRIBUTING.rst) for contribution guidelines. -======= -`sbws` will be considered production ready when version 1.0.0 will be releases. +`sbws` will be considered production ready when version 1.0.0 will be released. + +Installing +------------ + +See ./INSTALL.rst (or [INSTALL](./INSTALL.rst) or [INSTALL](./INSTALL.html) ) + +Deploying and running +--------------------- + +See ./DEPLOY.rst (or [DEPLOY](./DEPLOY.rst) or [DEPLOY](./DEPLOY.html) ) + +Contributing +-------------- + +See ./CONTRIBUTING.rst (or [CONTRIBUTING](./CONTRIBUTING.rst) or +[CONTRIBUTING](./CONTRIBUTING.html) ) + +Changelog +-------------- + +See ./CHANGELOG.rst (or [CHANGELOG](./CHANGELOG.rst) or +[CHANGELOG](./CHANGELOG.html) ) + +Documentation +-------------- More extensive documentation can be found in the ./docs directory, -also online at https://sbws.readthedocs.io and +and online at [sbws.rtfd.io](https://sbws.readthedocs.io) and [this onion service](http://d7pxflytfsmz6uh3x7i2jxzzwea6nbpmtsz5tmfkcin5edapaig5vpyd.onion/) ([v2](http://sdmb3rfvp3wadu6y.onion/)). @@ -36,4 +57,4 @@ software in ./LICENSE.md ## Authors -See ./AUTHORS.md \ No newline at end of file +See ./AUTHORS.md (or [AUTHORS](./AUTHORS.MD) \ No newline at end of file

1 0

[sbws/master] Rename section, add feature requests
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit f9511a348cb5c32f589cd9d7c1c9cdb0a34a7bcd Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 14:56:36 2018 +0000 Rename section, add feature requests --- CONTRIBUTING.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d0806dd..22c7e3e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -10,8 +10,8 @@ Examples of contributions include: * Bug reports, feature requests * Code/documentation patches -Bug reports ------------- +Bug reports or feature requests +--------------------------------- Check that bug has not been already reported. To report bugs or request features, open a ticket in

1 0

[sbws/master] Leave default sphinx message
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 1a33a1ba4da03ff0c65dbc8315f154ddd6d94988 Author: juga0 <juga(a)riseup.net> Date: Mon Sep 17 14:13:41 2018 +0000 Leave default sphinx message --- docs/source/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 68942da..098268d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,6 +1,5 @@ .. simple-bw-scanner documentation master file, created by sphinx-quickstart on Fri Mar 23 16:20:02 2018. - and modified slightly since thing. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.

1 0

[sbws/master] Stop using simple-bw-scanner in docs
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 9aa0813343964702e6f265d7796cce22ae1f4104 Author: juga0 <juga(a)riseup.net> Date: Mon Sep 17 14:09:40 2018 +0000 Stop using simple-bw-scanner in docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 36f0bb1..38cb183 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status](https://travis-ci.org/torproject/sbws.svg?branch=master)](https://t… -`simple-bw-scanner` (also called `sbws`) is a Tor bandwidth scanner that +Simple Bandwidth Scanner (called `sbws`) is a Tor bandwidth scanner that produces bandwidth measurements files to be used by Directory Authorities. The scanner builds two hop circuits consisting of the relay being measured and

1 0

[sbws/master] Rephrase, add links, remove :term:
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit d4141d87813d9138e31588caab8a2f5d44ed7e46 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:02:11 2018 +0000 Rephrase, add links, remove :term: --- DEPLOY.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index bbf40f0..6789db4 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -8,7 +8,7 @@ To run sbws is needed: - A machine to run the :term:`scanner`. - One or more :term:`destination` (s) that serve a large file. -Both the ``scanner`` and your the ``destination``(s) should be on fast, +Both the ``scanner`` and your the ``destination`` (s) should be on fast, well connected machines. .. _destinations_requirements: @@ -32,5 +32,5 @@ To configure destinations, create a configuration file according to ``./docs/source/man_sbws.ini.rst`` (or `/docs/source/man_sbws.ini.rst <man_sbws.ini>`_ or :doc:`man_sbws.ini` or ``man sbws.ini``) -See also ``/docs/source/man_sbws.rst`` (or `/docs/source/man_sbws.rst`_ or +See also ``./docs/source/man_sbws.rst`` (or `/docs/source/man_sbws.rst <man_sbws>`_ or :doc:`man_sbws` or ``man sbws``) manual page.

1 0

[sbws/master] Update Debian installation info
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 4945230f62a7eecdf2d37dcd43ea94ca383939cd Author: juga0 <juga(a)riseup.net> Date: Mon Sep 17 15:22:21 2018 +0000 Update Debian installation info --- INSTALL.rst | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 5ad7875..04bdac2 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -3,10 +3,18 @@ Installing Simple Bandwidth Scanner =================================== -The prefered method to install ``sbws`` is to install it from your system +The recommended method is to install it from your system distribution. -Currently there is not any system distribution package. -In the meantime, follow the following steps. + +In Debian/Ubuntu systems:: + + sudo apt install sbws + +To install also the documentation:: + + sudo apt install sbws-doc + +Continue reading to install ``sbws`` in other ways. System requirements -------------------- @@ -46,7 +54,9 @@ Install the python dependencies:: an ``stem`` release > 1.6.0 ``sbws`` needs :term:`destination` s to request files from. -Please, see :ref:`deploy` to know how to configure, deploy and run ``sbws``. + +Please, see ./DEPLOY.rst (or `/DEPLOY.rst </DEPLOY.rst>`_ or :ref:`deploy`) +to configure, deploy and run ``sbws``. System physical requirements ----------------------------- @@ -81,6 +91,3 @@ are 10MB and it will keep 50 rotated log files. .. _pytest: https://docs.pytest.org/ .. _tox: https://tox.readthedocs.io .. _Coverage: https://coverage.readthedocs.io/ -.. _Sphinx: http://www.sphinx-doc.org -.. _recommonmark: https://recommonmark.readthedocs.io/ -.. _Pylint: https://www.pylint.org/

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits September 2018