docs/modules/admin/pages/sitemap_admin.adoc

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