DEPLOY.rst 2.3 KB
Newer Older
1
Deploying Simple Bandwidth Scanner
Matt Traudt's avatar
Matt Traudt committed
2
=====================================
3
4
5

So you want to run sbws for yourself. You will need

Matt Traudt's avatar
Matt Traudt committed
6
7
8
- A machine to measure from, hereafter referred to as |scanner_nick|.
- One or more webservers hosting a large file, hereafter referred to as
  |dests|.
9

Matt Traudt's avatar
Matt Traudt committed
10
11
Both |scanner_nick| and your |dests| should be on fast, well connected
machines.
12

Matt Traudt's avatar
Matt Traudt committed
13
14
|scanner_nick| requirements
-------------------------------
15

Matt Traudt's avatar
Matt Traudt committed
16
17
18
19
20
- A fast, well connected machine on the Internet. Ideally its bandwidth should
  not be a limiting factor in measurements.
- Linux host OS
- Python 3, virtualenv
- Tor installed with ``tor`` in your ``PATH``
21

Matt Traudt's avatar
Matt Traudt committed
22
23
|dests| requirements
-------------------------------
24

Matt Traudt's avatar
Matt Traudt committed
25
26
27
28
29
30
- A fast, well connected machine on the Internet. Ideally its bandwidth should
  not be a limiting factor in measurements.
- Some sort of webserver installed and running that supports HEAD and GET
  requests (apache and nginx fit this description)
- Optional support for TLS
- A large file; at the time of writing, at least 1 GiB in size
31

Matt Traudt's avatar
Matt Traudt committed
32
33
|scanner_nick| setup
-------------------------------
34
35


Matt Traudt's avatar
Matt Traudt committed
36
Install sbws according to :doc:`/INSTALL`.
37

Matt Traudt's avatar
Matt Traudt committed
38
39
Make sure you have initialized sbws. If you haven't already run ``sbws init``,
then enter your virtualenv and run it.
40

Matt Traudt's avatar
Matt Traudt committed
41
42
43
Inside |dotsbws| you will find ``config.ini``. Open it with a text editor. it
should be very simple. Let's give our scanner a nickname. Add the following
lines
44
45
46

::

Matt Traudt's avatar
Matt Traudt committed
47
48
    [scanner]
    nickname = D0ntD3@dOpen!nside
49

Matt Traudt's avatar
Matt Traudt committed
50
51
(Pick your own nickname. This one just demonstrates that you can use almost any
character)
52

Matt Traudt's avatar
Matt Traudt committed
53
54
Congratulations, you've learned how to add a section to your config file and
how to add an option to a section.
55

Matt Traudt's avatar
Matt Traudt committed
56
57
Remeber |dests|? We need to add them to ``config.ini``. We're going to assume
you have two you are ready to use and one that isn't quite ready yet.
58
59
60

::

Matt Traudt's avatar
Matt Traudt committed
61
62
63
64
    [destinations]
    foo = on
    bar = on
    baz = off
65

Matt Traudt's avatar
Matt Traudt committed
66
67
    [destinations.foo]
    url = http://fooshoomoo.com/sbws.bin
68

Matt Traudt's avatar
Matt Traudt committed
69
70
    [destinations.bar]
    url = https://barstoolsinc.com
71

Matt Traudt's avatar
Matt Traudt committed
72
73
    [destinations.baz]
    url = https://bazistan.com/ask/stan/where/the/file/is.exe
74

Matt Traudt's avatar
Matt Traudt committed
75
``foo`` demonstrates a typical case.
76

Matt Traudt's avatar
Matt Traudt committed
77
78
79
``bar`` demonstrates a case where you want to use HTTPS and want to assume the
large file for sbws to download is at its default path (probably
``/sbws.bin``).
juga's avatar
juga committed
80

Matt Traudt's avatar
Matt Traudt committed
81
``baz`` demonstrates a disabled destination that sbws will ignore.
juga's avatar
juga committed
82