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