doc/man/gnunet-gns-proxy.1

   1 .\" This file is part of GNUnet.
   2 .\" Copyright (C) 2001-2019 GNUnet e.V.
   3 .\"
   4 .\" Permission is granted to copy, distribute and/or modify this document
   5 .\" under the terms of the GNU Free Documentation License, Version 1.3 or
   6 .\" any later version published by the Free Software Foundation; with no
   7 .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
   8 .\" copy of the license is included in the file
   9 .\" ``FDL-1.3''.
  10 .\"
  11 .\" A copy of the license is also available from the Free Software
  12 .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
  13 .\"
  14 .\" Alternately, this document is also available under the General
  15 .\" Public License, version 3 or later, as published by the Free Software
  16 .\" Foundation.  A copy of the license is included in the file
  17 .\" ``GPL3''.
  18 .\"
  19 .\" A copy of the license is also available from the Free Software
  20 .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
  21 .\"
  22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23 .\"
  24 .Dd October 25, 2012
  25 .Dt GNUNET-GNS-PROXY 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-gns-proxy
  29 .Nd
  30 run a client side GNS SOCKS proxy
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  34 .Op Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY
  35 .Op Fl p Ar PORT | Fl \-port= Ns Ar PORT
  36 .Op Fl h | \-help
  37 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  38 .Op Fl v | \-version
  39 .Sh DESCRIPTION
  40 Most users will want to run this SOCKS proxy.
  41 It can be used in combination with browsers that support the SOCKS 4a protocol.
  42 .Pp
  43 The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content.
  44 To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy.
  45 Thus "gnunet-gns-proxy-setup-ca" should be executed before the first launch of this proxy or the \-\-authority switch is used to specify an appropriate CA certificate that is already trusted by the browser.
  46 .Bl -tag -width Ds
  47 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  48 Use the configuration file FILENAME.
  49 .It Fl a Ar AUTHORITY | Fl \-authority= Ns Ar AUTHORITY
  50 Path to a PEM CA file that contains the certificate and private key of the CA to use to assert the validity of GNS names.
  51 The default port is specified in the configuration file for the gns service under "[gns-proxy]":
  52 "[gns-proxy]"
  53 PROXY_CACERT
  54 .It Fl p Ar PORT | Fl \-port= Ns Ar PORT
  55 The port this proxy should listen on. Default is 7777.
  56 .It Fl h | \-help
  57 Print short help on options.
  58 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  59 Use LOGLEVEL for logging.
  60 Valid values are DEBUG, INFO, WARNING and ERROR.
  61 .It Fl v | \-version
  62 Print GNUnet version number.
  63 .El
  64 .\".Sh EXAMPLES
  65 .Sh SEE ALSO
  66 .Xr gnunet-gns 1
  67 .sp
  68 The full documentation for gnunet is maintained as a Texinfo manual.
  69 If the
  70 .Xr info 1
  71 and gnunet programs are properly installed at your site, the command
  72 .Pp
  73 .Dl info gnunet
  74 .Pp
  75 should give you access to the complete handbook,
  76 .Pp
  77 .Dl info gnunet-c-tutorial
  78 .Pp
  79 will give you access to a tutorial for developers.
  80 .sp
  81 Depending on your installation, this information is also available in
  82 .Xr gnunet 7 and
  83 .Xr gnunet-c-tutorial 7 .
  84 .\".Sh HISTORY
  85 .\".Sh AUTHORS
  86 .Sh BUGS
  87 Report bugs by using
  88 .Lk https://bugs.gnunet.org
  89 or by sending electronic mail to
  90 .Aq Mt gnunet-developers@gnu.org .