git.sur5r.net Git - openldap/blob - clients/gopher/README

   1 This directory contains source for two programs:
   2
   3         go500           A gopher index search server to X.500 gateway
   4
   5         go500gw         A more general gopher to X.500 gateway
   6
   7 Both programs use the LDAP protocol to talk to X.500.  If you did not
   8 get this software with the U-M LDAP software distribution, you will
   9 need to have the LDAP libraries on hand to be able to make this software.
  10 The LDAP distribution is available for anonymous ftp from the host
  11 terminator.rs.itd.umich.edu in the x500/ directory.
  12
  13 What you are trying to set up looks like this:
  14
  15  --------             -----------------            --------           --------
  16 | gopher |           | gopher to| LDAP |          | LDAP   |         | X.500  |
  17 | client |<- gophr ->| LDAP g/w | API  |<- LDAP ->| server |<- DAP ->| server |
  18 |________|           |__________|______|          |________|         |________|
  19                        go500gw                      ldapd
  20                          or
  21                         go500
  22
  23 Both go500 and go500gw can be run either from inetd or as stand-alone
  24 servers.
  25
  26 go500 is useful when you always want to search a fixed portion of the X.500
  27 tree.  It does not let you browse around or change where you search.
  28
  29 go500gw is useful when you want to provide a more general and flexible
  30 gateway from gopher to X.500.  It allows users to browse around anywhere
  31 in the X.500 tree, doing searches at any point.
  32
  33 **************************************************************************
  34 *                            RUNNING go500                                *
  35 **************************************************************************
  36
  37 1) Make and install the ldap distribution if you have not already done so:
  38
  39         (cd ../; make lib-only; make inst-lib)
  40
  41    or
  42
  43         (cd ../; make all; make install)
  44
  45    Use the second form if you don't already have an ldapd running
  46    somewhere you can connect to.  Note that to make an ldap server,
  47    you will need the ISODE libraries and include files.
  48
  49 2) Tailor go500 to your site before compiling:
  50
  51         vi go500.c
  52
  53    There are a couple of things to change in go500.c:
  54
  55         DAPUSER - This is the DN go500 will bind to the directory as.
  56                 You can specify NULL if you want.
  57
  58         DEFAULT_BASE - This is the DN of the object below which go500
  59                 will conduct its search.  You typically want this to
  60                 be the DN or your organization.
  61
  62         DEFAULT_LDAPHOST - This is the host that is running the ldap
  63                 server.  If it's not on the localhost, you'll need to
  64                 change this.
  65
  66 3) Make go500:
  67
  68         make
  69
  70 4) Start the ldap daemon:
  71
  72         ldapd [-c dsaname]
  73
  74    You only need to do this if you're not already running one.
  75
  76 5) Start go500 as a stand-alone server:
  77
  78         go500
  79
  80    or arrange to have it start from inetd:
  81
  82         # vi /etc/services      /* add the following line */
  83         go500           5555/tcp        go500           # go500 server
  84
  85         # vi /etc/inetd.conf    /* add the following line */
  86         go500   stream  tcp     nowait  nobody  $(ETCDIR)/go500    go500 -I
  87
  88         # kill -HUP <inetdpid>  /* make inetd notice the change */
  89
  90    where $(ETCDIR) is replaced by the ETCDIR from the top level Makefile
  91    and <inetdpid> is replaced by the pid of the inetd process.
  92
  93 6) Configure your local gopher server to have an entry for go500.
  94    A sample .link file is given below, with the things you should
  95    change given in <>'s:
  96
  97         Name=<Label of your choice>
  98         Type=7
  99         Port=5555
 100         Path=
 101         Host=<host.running.go500.here>
 102
 103    You may also have to restart your gopher daemon, or remove
 104    the .cache file.
 105
 106 7) Run a gopher client and try it out.
 107
 108 **************************************************************************
 109 *                           RUNNING go500gw                              *
 110 **************************************************************************
 111
 112 1) Make the ldap distribution if you have not already done so:
 113
 114         (cd ../; make lib-only)
 115
 116    or
 117
 118         (cd ../; make lib-only ldap-server)
 119
 120    Use the second form if you don't already have an ldapd running
 121    somewhere you can connect to.  Note that to make an ldap server,
 122    you will need the ISODE libraries and include files.
 123
 124 2) Tailor go500gw to your site before compiling:
 125
 126         vi go500gw.c
 127
 128    There are a couple of things to change in go500gw.c:
 129
 130         GO500DN - This is the DN go500gw will bind to the directory as.
 131                 You can specify NULL if you want.
 132
 133         HELPFILE - This is the pathname of the helpfile (actually, the
 134                 file that's displayed when a user chooses "About the
 135                 Gopher to X.500 Gateway").
 136
 137         LDAPHOST - This is the host that is running the ldap server.
 138                 If it's not on the localhost, you'll need to change this.
 139
 140 3) Make go500gw:
 141
 142         make
 143
 144 4) Start the ldap daemon:
 145
 146         ldapd [-c dsaname]
 147
 148    You only need to do this if you're not already running one.
 149
 150 5) Start go500gw either as a stand-alone server:
 151
 152         go500gw
 153
 154    or arrange to have it start from inetd:
 155
 156         # vi /etc/services      /* add the following line */
 157         go500gw           5555/tcp        go500gw           # go500gw server
 158
 159         # vi /etc/inetd.conf    /* add the following line */
 160         go500gw stream  tcp     nowait  nobody  $(ETCDIR)/go500gw  go500gw -I
 161
 162         # kill -HUP <inetdpid>  /* make inetd notice the change */
 163
 164    where $(ETCDIR) is replaced by the ETCDIR from the top level Makefile
 165    and <inetdpid> is replaced by the pid of the inetd process.
 166
 167 6) Configure your local gopher server to have an entry for go500gw.
 168    A sample .link file is given below, with the things you should
 169    change given in <>'s:
 170
 171         Name=<Label of your choice>
 172         Type=1
 173         Port=7777
 174         Path=M
 175         Host=<host.running.go500gw.here>
 176
 177    You may also have to restart your gopher daemon, or remove
 178    the .cache file.
 179
 180    If you want to start go500gw at some point in the X.500 tree
 181    other than the root, you can change the Path parameter above
 182    to something like this, for example:
 183
 184         Path=Mo=University of Michigan,c=US
 185
 186    Of course, you would substitute your own organization's DN.
 187
 188 7) Run a gopher client and try it out.