DEPLOY.rst 1.88 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
21
- A Web server installed and running that supports HTTP GET, HEAD and
  Range (:rfc:`7233`) requests.
  ``Apache`` HTTP Server and ``Nginx`` support them.
Matt Traudt's avatar
Matt Traudt committed
22
23
- Optional support for TLS
- A large file; at the time of writing, at least 1 GiB in size
24

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

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

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

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

36
37
38
39
* ``~/.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
40

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

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

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

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

Matt Traudt's avatar
Matt Traudt committed
53
    [destinations.foo]
juga's avatar
juga committed
54
    url = http://example.org/sbws.bin
55

Matt Traudt's avatar
Matt Traudt committed
56
    [destinations.bar]
juga's avatar
juga committed
57
    url = https://example.com
58

Matt Traudt's avatar
Matt Traudt committed
59
    [destinations.baz]
juga's avatar
juga committed
60
    url = https://example.net/ask/stan/where/the/file/is.exe
61

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

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

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