taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

paivana-httpd.1.rst (2051B)


      1 paivana-httpd(1)
      2 ################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **paivana-httpd** - reverse-proxy paywall
     10 
     11 
     12 Synopsis
     13 ========
     14 
     15 **paivana-httpd**
     16 [**-f**_|_**--respect-forwarded-headers**]
     17 [**-h**_|_**--help**]
     18 [**-g**_|_**--global-payment**]
     19 [**-n**_|_**--no-payment**]
     20 [**-u** *BYTES*_|_**--max-upload=**\ \ *BYTES*]
     21 [**-v**_|_**--version**]
     22 
     23 Description
     24 ===========
     25 
     26 **paivana-httpd** is a reverse proxy that requires the client to
     27 make a payment using GNU Taler before forwarding the request.
     28 The reverse proxy uses a GNU Taler merchant backend to process
     29 payments and also learns which websites require payment and how
     30 much the prices are. Thus, the main configuration is done within
     31 the Taler merchant backend.
     32 
     33 paivana-httpd will simply open an HTTP socket, listen for incoming
     34 requests, and if they are paid (or do not require payment) forward
     35 them to the respective webserver configured.
     36 
     37 Its options are as follows:
     38 
     39 **-f** | **--respect-forwarded-headers**
     40    If set, derive the client address from the leftmost entry of the
     41    "X-Forwarded-For" request header (falling back to the socket
     42    address only when the header is absent).  Only enable this when
     43    paivana-httpd is itself behind a trusted reverse proxy that
     44    sanitizes that header - otherwise clients can spoof their address.
     45 
     46 **-h** | **--help**
     47    Print short help on options.
     48 
     49 **-g** | **-global-payment**
     50    Disable per-page payment, a single payment is always valid
     51    for the entire site.
     52 
     53 **-n** | **-no-payment**
     54    Disable payment, only act as a reverse proxy that does nothing.
     55    Useful to temporarily disable the paywall or to test the
     56    reverse proxy itself.
     57 
     58 **-u** *BYTES* |  **--max-upload=**\ \ *BYTES*
     59    Set the maximum upload size allowed by the reverse proxy.
     60    Only applies to the body size (the HTTP header has a separate limit).
     61 
     62 **-v** | **--version**
     63    Print version number.
     64 
     65 See Also
     66 ========
     67 
     68 taler-merchant-httpd(1), paivana.conf(5)
     69 
     70 Bugs
     71 ====
     72 
     73 Report bugs by using https://bugs.taler.net or by sending electronic
     74 mail to <taler@gnu.org>.