DEPLOY.rst 1.86 KB
Newer Older
juga's avatar
juga committed
1
2
.. _deploy:

3
Deploying Simple Bandwidth Scanner
Matt Traudt's avatar
Matt Traudt committed
4
=====================================
5
6
7

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

juga's avatar
juga committed
8
9
- A machine to run the :term:`scanner`.
- One or more :term:`destination` (s) that serve a large file.
10

juga's avatar
juga committed
11
12
Both :term:`scanner` and your :term:`destination` (s) should be on fast,
well connected machines.
13

14
.. _destinations_requirements:
15

16
17
:term:`destination` requirements
------------------------------------
18

19
20
- A Web server installed and running that supports HEAD and GET
  requests (``apache`` and ``nginx`` fit this description)
Matt Traudt's avatar
Matt Traudt committed
21
22
- Optional support for TLS
- A large file; at the time of writing, at least 1 GiB in size
23

juga's avatar
juga committed
24
25
:term:`scanner` setup
----------------------
26

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

29
30
``sbws`` needs :term:`destination` (s) to request files from.
They are not included by default.
31

32
33
To configure destinations, create a file called ``config.ini``. It can be
located in:
34

35
36
37
38
* ``~/.sbws/`` if you are running ``sbws`` manually
* ``/etc/sbws`` if you are running ``sbws`` from a system package as a
  ``systemd`` directory (not yet supported)
* any localion, an specify the path via the ``-c`` argument
39

40
And edit destinations according to :doc:`man_sbws.ini`
41

juga's avatar
juga committed
42
43
It is not required, but it is recomended to include a custom scanner
``nickname`` in ``config.ini``.
44

juga's avatar
juga committed
45
Destination(s) configuration in more detail::
46

Matt Traudt's avatar
Matt Traudt committed
47
48
49
50
    [destinations]
    foo = on
    bar = on
    baz = off
51

Matt Traudt's avatar
Matt Traudt committed
52
53
    [destinations.foo]
    url = http://fooshoomoo.com/sbws.bin
54

Matt Traudt's avatar
Matt Traudt committed
55
56
    [destinations.bar]
    url = https://barstoolsinc.com
57

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

Matt Traudt's avatar
Matt Traudt committed
61
``foo`` demonstrates a typical case.
62

Matt Traudt's avatar
Matt Traudt committed
63
64
65
``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
66

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