doc/man/gnunet-namestore-fcfsd.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 September 5, 2013
  25 .Dt GNUNET-NAMESTORE-FCFSD 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-namestore-fcfsd
  29 .Nd HTTP server for GNU Name System First-Come-First-Served name registration
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  33 .Op Fl h | -help
  34 .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  35 .Op Fl v | -version
  36 .Op Fl z Ar EGO | -zone= Ns Ar EGO
  37 .Sh DESCRIPTION
  38 Most users will not want to run an FCFS-zone and thus will not need this program.
  39 .Pp
  40 .Nm
  41 runs a web server where users can register names to be mapped to their GNS zone.
  42 Names are made available on a First Come First Served basis (hence fcfs).
  43 Registered names do not expire.
  44 The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT".
  45 .Pp
  46 It is possible to manage gnunet-gns-fcfsd using gnunet-(service-arm) by starting the daemon using "gnunet-arm -i fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your configuration and the "-z ZONE" in as the "OPTION".
  47 .Pp
  48 An FCFS-zone is run at
  49 .Lk http://gnunet.org/fcfs/ .
  50 GNS users are encouraged to register their zone with the gnunet.org FCFS authority.
  51 .Pp
  52 If you want to run your own FCFS registrar, you need to first create a pseudonym (using "gnunet-identity -C NAME"), and use it with the
  53 .Fl z
  54 option.
  55 After that, you can start the FCFSD service (possibly using
  56 .Xr gnunet-arm 1 Ns ).
  57 .Pp
  58 The options are as follows:
  59 .Bl -tag -width indent
  60 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  61 Use the configuration file FILENAME.
  62 .It Fl h | -help
  63 Print short help on options.
  64 .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  65 Use LOGLEVEL for logging.
  66 Valid values are DEBUG, INFO, WARNING and ERROR.
  67 .It Fl v | -version
  68 Print GNUnet version number.
  69 .It Fl z Ar EGO | -zone= Ns Ar EGO
  70 Specifies for which
  71 .Ar EGO
  72 FCFSD should manage the zone.
  73 .El
  74 .\".Sh EXAMPLES
  75 .\".Sh FILES
  76 .Sh SEE ALSO
  77 .Xr gnunet-identity 1 ,
  78 .Xr gnunet-gns 1 ,
  79 .Xr gnunet-gns-proxy 1
  80 .sp
  81 The full documentation for gnunet is maintained as a Texinfo manual.
  82 If the
  83 .Xr info 1
  84 and gnunet programs are properly installed at your site, the command
  85 .Pp
  86 .Dl info gnunet
  87 .Pp
  88 should give you access to the complete handbook,
  89 .Pp
  90 .Dl info gnunet-c-tutorial
  91 .Pp
  92 will give you access to a tutorial for developers.
  93 .sp
  94 Depending on your installation, this information is also available in
  95 .Xr gnunet 7 and
  96 .Xr gnunet-c-tutorial 7 .
  97 .\".Sh HISTORY
  98 .\".Sh AUTHORS
  99 .Sh BUGS
 100 Report bugs by using
 101 .Lk https://bugs.gnunet.org
 102 or by sending electronic mail to
 103 .Aq Mt gnunet-developers@gnu.org .