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 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 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 run a client-side GNS SOCKS proxy
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  33 .Op Fl a Ar AUTHORITY | Fl -authority= Ns Ar AUTHORITY
  34 .Op Fl p Ar PORT | Fl -port= Ns Ar PORT
  35 .Op Fl h | -help
  36 .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  37 .Op Fl v | -version
  38 .Sh DESCRIPTION
  39 Most users will want to run this SOCKS proxy.
  40 It can be used in combination with browsers that support the SOCKS 4a protocol.
  41 .Pp
  42 The proxy will perform SSL authentication of GNS names and rewrite GNS enabled HTML content.
  43 To assert the validity of GNS names a local root CA certificate has to be generated that is used by the proxy.
  44 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.
  45 .Bl -tag -width indent
  46 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  47 Use the configuration file FILENAME.
  48 .It Fl a Ar AUTHORITY | Fl -authority= Ns Ar AUTHORITY
  49 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.
  50 The default port is specified in the configuration file for the gns service under "[gns-proxy]":
  51 "[gns-proxy]"
  52 PROXY_CACERT
  53 .It Fl p Ar PORT | Fl -port= Ns Ar PORT
  54 The port this proxy should listen on. Default is 7777.
  55 .It Fl h | -help
  56 Print short help on options.
  57 .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  58 Use LOGLEVEL for logging.
  59 Valid values are DEBUG, INFO, WARNING and ERROR.
  60 .It Fl v | -version
  61 Print GNUnet version number.
  62 .El
  63 .\".Sh EXAMPLES
  64 .Sh SEE ALSO
  65 .Xr gnunet-gns 1
  66 .sp
  67 The full documentation for gnunet is maintained as a Texinfo manual.
  68 If the
  69 .Xr info 1
  70 and gnunet programs are properly installed at your site, the command
  71 .Pp
  72 .Dl info gnunet
  73 .Pp
  74 should give you access to the complete handbook,
  75 .Pp
  76 .Dl info gnunet-c-tutorial
  77 .Pp
  78 will give you access to a tutorial for developers.
  79 .sp
  80 Depending on your installation, this information is also available in
  81 .Xr gnunet 7 and
  82 .Xr gnunet-c-tutorial 7 .
  83 .\".Sh HISTORY
  84 .\".Sh AUTHORS
  85 .Sh BUGS
  86 Report bugs by using
  87 .Lk https://bugs.gnunet.org
  88 or by sending electronic mail to
  89 .Aq Mt gnunet-developers@gnu.org .