OGUP

This directory contains the source files of the OGUP project.

The web homepage of the ogup project is located at http://ogup.osdn.io


=== BUILD ====================================================================

Building the OGUP requires an ANSI C compiler (preferably gcc or clang) to
build the 'gopherjoker' crawler.


=== RUN ======================================================================

The 'frontend' directory can be served with a gopher server to present users
with the OGUP interface. This has been tested exclusively with the Motsognir
gopher server, and is unlikely to function properly with a different server.

If the build process was successful, a 'gopherjoker' binary should have
appeared in the gopherjoker directory. This is a gopher crawler that will
spider the gopherspace. It should be executed as such:

  $ gopherjoker ogupdb.dat ogupdb.cnt

ogupdb.dat is a comma-separated-value text file that gopherjoker uses as its
database of known gopher servers. ogupdb.cnt is a file that contains only
global counters of known servers, that is used by the OGUP frontend.

The ogupdb.dat and ogupdb.cnt files should be stored in the directory where
OGUP's frontend lives, so the frontend always has most up-to-date data.

Both ogupdb.dat and ogupdb.cnt are updated only once an hour by gopherjoker,
to avoid too much filesystem updates.


=== LEARNING NEW SERVERS =====================================================

gopherjoker learns about new gopher servers by discovering menu listings of
existing (known) servers. It is also possible to hand-feed gopherjoker with
new servers, the frontend has an appropriate submission form for that. This
form writes submissions to the /tmp/ogup/ directory, where they are picked up
by gopherjoker (and deleted by gopherjoker afterwards).


=== LICENSE ==================================================================

All OGUP files are made available under the terms of the MIT License.

Copyright (C) 2019-2021 Mateusz Viste

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.