DEPLOY.rst 1.18 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

juga's avatar
juga committed
6
To run sbws is needed:
7

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
Both the ``scanner`` and your the ``destination`` (s) should be on fast,
juga's avatar
juga committed
12
well connected machines.
13

14
.. _destinations_requirements:
15

juga's avatar
juga committed
16
destination requirements
17
------------------------------------
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
scanner setup
juga's avatar
juga committed
26
----------------------
27

28
29
Install sbws according to `<INSTALL.rst>`_ (in the local directory or GitHub)
or `<INSTALL.html>`_  (local build or Read the Docs).
30

31
To configure destinations, create a configuration file according to
32
33
34
``./docs/source/man_sbws.ini.rst`` (in the local directory or GitHub) or
`<man_sbws.ini.html>`_  (local build or Read the Docs) or
``man sbws.ini`` (Debian).
juga's avatar
juga committed
35

36
37
See also ``./docs/source/man_sbws.rst`` (in the local directory or GitHub) or
`<man_sbws.html>`_ (local build or Read the Docs) or ``man sbws`` (Debian).