docs/admin/sitemap_admin.adoc

   1 Running the sitemap generator
   2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   3 The `sitemap_generator` script must be invoked with the following argument:
   4
   5 * `--lib-hostname`: specifies the hostname for the catalog (for example,
   6   `--lib-hostname https://catalog.example.com`); all URLs will be generated
   7   appended to this hostname
   8
   9 Therefore, the following arguments are useful for generating multiple sitemaps
  10 per Evergreen instance:
  11
  12 * `--lib-shortname`: limit the list of record URLs to those which have copies
  13   owned by the designated library or any of its children;
  14 * `--prefix`: provides a prefix for the sitemap index file names
  15
  16 Other options enable you to override the OpenSRF configuration file and the
  17 database connection credentials, but the default settings are generally fine.
  18
  19 Note that on very large Evergreen instances, sitemaps can consume hundreds of
  20 megabytes of disk space, so ensure that your Evergreen instance has enough room
  21 before running the script.
  22
  23 Sitemap details
  24 ~~~~~~~~~~~~~~~
  25
  26 The sitemap generator script includes located URIs as well as copies
  27    listed in the `asset.opac_visible_copies` materialized view, and checks
  28    the children or ancestors of the requested libraries for holdings as well.
  29
  30 Scheduling
  31 ~~~~~~~~~~
  32 To enable search engines to maintain a fresh index of your bibliographic
  33 records, you may want to include the script in your cron jobs on a nightly or
  34 weekly basis.
  35
  36 Sitemap files are generated in the same directory from which the script is
  37 invoked, so a cron entry will look something like:
  38
  39 ------------------------------------------------------------------------
  40 12 2 * * * cd /openils/var/web && /openils/bin/sitemap_generator
  41 ------------------------------------------------------------------------
  42