Skip to content

settings.md

Latest commit

 

History

History
84 lines (60 loc) · 3.08 KB

settings.md

File metadata and controls

84 lines (60 loc) · 3.08 KB

Settings Overview and Basics

When you first run the Orchid generator (rails g setup in the installation), you will be asked to answer a series of prompts. Never fear if you don't know what to answer, you can change those values at any time!

Locating Settings

Nearly all of the configuration is either in config/public.yml, config/private.yml, or config/locales/[language].yml.

If you are updating your version of Orchid, you will want to compare your version of these files against the Orchid config template files to see if any changes need to be made.

config/public.yml and config/private.yml contain information about how to connect to services (like the API), and default settings for things like search and browse facets, site sections, and redirects.

config/locales/[language].yml is where you can change your site title and other information. Read more in the languages documentation.

Most of the options in the config files are well documented in the files themselves, there are a few config settings of which you should be aware.

API Connection

In private.yml, you may set your API path by environment. This path may be any endpoint in the API to which /items can be appended.

The default api_path value is https://cdrhapi.unl.edu/v1.

# config/private.yml

api_path: https://cdrhapi.unl.edu/v1
api_path: https://cdrhapi.unl.edu/v1/collection/collection_name

Orchid sets up its API endpoint with some default values, listed under api_options. You may change the following in config/public.yml:

  • The number of search results which come back by default
  • The type of sort which will be used for browsing
  • Facet list sizes and sorting
  • The earliest and latest dates of the app's documents

All of these settings may be overridden in specific requests later as well. For more information about these values and options, please consult the Apium documentation.

Image Server

In the event that the items returned from the API for search results have images, or if you would like to use images on any item or custom pages, you may wish to use a IIIF-compatible image server.

Fill in the path to this image server in private.yml. If you are using the cdrhmedia server, do not include the collection in the path.

# config/private.yml

iiif_path: https://cdrhmedia.unl.edu/iiif/2

You will also need to include a little more information in config/public.yml about your collection and your preferred thumbnail size. The collection_name is the appropriate subdirectory in the image server file system. The thumbnail_size, when beginning with !, will not alter the height / width ratio of the image.

media_server_dir: collection_name
thumbnail_size: "!200,200"

For more information about using IIIF images in Orchid, please see the helpers documentation.