|
| 1 | +# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # |
| 2 | +# __ # |
| 3 | +# .-----.---.-.-----.| | # |
| 4 | +# | _ | _ | || | # |
| 5 | +# | __|___._|__|__||__| # |
| 6 | +# |__| ... .-.. # |
| 7 | +# # |
| 8 | +# ~ ~ ~ * ~ ~ ~ # |
| 9 | +# # |
| 10 | +# PANL/SOLR SERVER CONNECTION CONFIGURATION # |
| 11 | +# --------- ------ ---------- ------------- # |
| 12 | +# # |
| 13 | +# This is the Panl configuration file which configures the base functionality # |
| 14 | +# and defines how Panl will connect to the Solr server. # |
| 15 | +# # |
| 16 | +# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # |
| 17 | + |
| 18 | +# Which Solr Client To Use |
| 19 | +# ----- ---- ------ -- --- |
| 20 | +# Choose the correct SolrJ client for the Solr installation that you require, |
| 21 | +# by default, it is the CloudSolrClient. |
| 22 | +# |
| 23 | +# NOTE: What the solr.search.server.url will be will depend on the client that |
| 24 | +# you choose. The SolrJ client __MUST__ be one of |
| 25 | +# |
| 26 | +# - Http2SolrClient |
| 27 | +# - HttpJdkSolrClient |
| 28 | +# - LBHttp2SolrClient |
| 29 | +# - CloudSolrClient |
| 30 | +# |
| 31 | +# By default - we will be using the CloudSolrClient as it works with the |
| 32 | +# example instructions for spinning up a test solr instance |
| 33 | +# |
| 34 | +# ~ ~ ~ * ~ ~ ~ |
| 35 | + |
| 36 | +solrj.client=Http2SolrClient |
| 37 | +#solrj.client=HttpJdkSolrClient |
| 38 | +#solrj.client=LBHttp2SolrClient |
| 39 | +#solrj.client=CloudSolrClient |
| 40 | + |
| 41 | +# Which Solr URLs To Connect To |
| 42 | +# ----- ---- ---- -- ------- -- |
| 43 | +# Dependent on which Solr server installation you have, and consequently the |
| 44 | +# SolrJ Client that is configured, this will either be a single url, or a comma |
| 45 | +# separated list of URLs |
| 46 | +# |
| 47 | +# solr.search.server.url - the search server URL to connect to which must |
| 48 | +# NOT include the core that it is connecting to - this will be taken |
| 49 | +# care of by the Panl request mechanism. |
| 50 | +# |
| 51 | +# NOTE: that if you are using connector that has multiple URLs, then |
| 52 | +# they MUST be comma separated. |
| 53 | +# |
| 54 | +# NOTE: If you are using the CloudSolrClient as a connector and you wish to |
| 55 | +# use the zookeeper URLs, then you __MUST__ prefix the URLs with |
| 56 | +# |
| 57 | +# zookeeper: |
| 58 | +# |
| 59 | +# The below property would then become: |
| 60 | +# |
| 61 | +# solr.search.server.url=zookeeper:localhost:9983 |
| 62 | +# |
| 63 | +# ~ ~ ~ * ~ ~ ~ |
| 64 | + |
| 65 | +solr.search.server.url=http://localhost:8983/solr |
| 66 | + |
| 67 | +# Whether To Enable The Testing URLs |
| 68 | +# ------- -- ------ --- ------- ---- |
| 69 | +# The Panl results viewer / explainer URLs, this is a simple web app which will |
| 70 | +# allow you to test and explain the collections and the URLs that are |
| 71 | +# generated, including fields, faceting, querying, sorting, and results. |
| 72 | +# |
| 73 | +# If this property does not exist, or if it is set to false, then no results |
| 74 | +# viewer /explainer will be available. You may wish to remove this property |
| 75 | +# for production (or perhaps just disallow access to it). |
| 76 | +# |
| 77 | +# The URI paths are __ALWAYS__ |
| 78 | +# /panl-results-viewer/ - for testing the queries, facets, and results |
| 79 | +# /panl-results-explainer/ - for explaining LPSE encoded URIs and describing |
| 80 | +# the configuration for the Panl server. |
| 81 | +# |
| 82 | +# ~ ~ ~ * ~ ~ ~ |
| 83 | + |
| 84 | +panl.results.testing.urls=true |
| 85 | + |
| 86 | +# Whether To Enable Verbose Error Messaging |
| 87 | +# ------- -- ------ ------- ----- --------- |
| 88 | +# Whether verbose messaging is turned on for the error (404 / 500) http status |
| 89 | +# messages. Verbose messaging for the 404 error will provide valid URI paths |
| 90 | +# to connect to. Verbose messaging for the 500 error will provide a |
| 91 | +# stacktrace. |
| 92 | +# |
| 93 | +# The recommendation is to set both of these properties to false to reduce the |
| 94 | +# possibility of information leakage. |
| 95 | +# |
| 96 | +# ~ ~ ~ * ~ ~ ~ |
| 97 | + |
| 98 | +panl.status.404.verbose=true |
| 99 | +panl.status.500.verbose=true |
| 100 | + |
| 101 | +# Decimal Values Format |
| 102 | +# ------- ------ ------ |
| 103 | +# Whether decimal values use a decimal point or a decimal comma. For example |
| 104 | +# The number |
| 105 | +# |
| 106 | +# 1,234,567.89 |
| 107 | +# |
| 108 | +# uses the decimal point '.' as the separator between the integer and the |
| 109 | +# fractional part, whereas the number |
| 110 | +# |
| 111 | +# 1.234.567,89 |
| 112 | +# |
| 113 | +# uses the decimal comma ',' as the separator between the integer and the |
| 114 | +# fractional part. |
| 115 | +# |
| 116 | +# The default for the Panl server is to use the decimal point, should you wish |
| 117 | +# to change this, set the property below to false to use the decimal comma |
| 118 | +# character for decimal values. |
| 119 | +# |
| 120 | +# ~ ~ ~ * ~ ~ ~ |
| 121 | + |
| 122 | +panl.decimal.point=true |
| 123 | + |
| 124 | + |
| 125 | +# Remove Un-needed JSON Keys |
| 126 | +# ------ --------- ---- ---- |
| 127 | +# Set this property to true is you do not require information in the JSON |
| 128 | +# response object. This will remove the JSON keys from the response: |
| 129 | +# |
| 130 | +# - facet_counts |
| 131 | +# - responseHeader.params |
| 132 | +# |
| 133 | +# If you are starting from a fresh implementation without any legacy use of the |
| 134 | +# original Solr response object, then this is safe to set to 'true' |
| 135 | +# |
| 136 | +# ~ ~ ~ * ~ ~ ~ |
| 137 | + |
| 138 | +panl.remove.solr.json.keys=false |
| 139 | + |
| 140 | +# Add 'extra' Information To Every Response |
| 141 | +# --- ------- ----------- -- ----- -------- |
| 142 | +# This property __MUST__ be a valid JSON object and will be added to every |
| 143 | +# response from the Panl server. It will be added to the JSON response object |
| 144 | +# under the panl.extra JSON key. |
| 145 | +# |
| 146 | +# You may also add an 'extra' JSON object to each of the collections, with the |
| 147 | +# panl.extra JSON key which will override any keys in this JSON object. |
| 148 | +# |
| 149 | +# IMPORTANT: |
| 150 | +# |
| 151 | +# - If this is not a valid JSON object, then the server will error and fail |
| 152 | +# to start. |
| 153 | +# - These values may be overwritten by the panl.collection.extra property in |
| 154 | +# the individual <panl_collection_url>.panl.properties files |
| 155 | +# - You may remove this property or leave it blank and it will have no effect |
| 156 | +# and will not be included in the Panl JSON Response |
| 157 | +# |
| 158 | +# ~ ~ ~ * ~ ~ ~ |
| 159 | + |
| 160 | +panl.server.extra= |
| 161 | + |
| 162 | +# Collection Property File Inclusion |
| 163 | +# ---------- -------- ---- --------- |
| 164 | +# Each property file defines a singular collection, with the associated |
| 165 | +# properties and configuration. The format of the property is: |
| 166 | +# |
| 167 | +# panl.collection.<solr_collection_name>=<properties_file_location> |
| 168 | +# |
| 169 | +# Where: |
| 170 | +# <solr_collection_name> is the collection to query on the Solr server |
| 171 | +# <properties_file_location> is the relative location __FROM__ this file |
| 172 | +# (i.e. the panl.properties file). The format of |
| 173 | +# the filename is: |
| 174 | +# |
| 175 | +# <panl_collection_uri>.panl.properties |
| 176 | +# |
| 177 | +# Where: |
| 178 | +# <panl_collection_uri> is the base URI path that the Panl server will |
| 179 | +# respond to, i.e. it will be bound to the Panl URL |
| 180 | +# of http://localhost:port/<panl_collection_uri> |
| 181 | +# |
| 182 | +# NOTE: You may have multiple <panl_collection_uri> values for each |
| 183 | +# <solr_collection_name> with different fieldset configurations |
| 184 | +# |
| 185 | +# ~ ~ ~ * ~ ~ ~ |
| 186 | + |
| 187 | +panl.collection.mechanical-pencils=mechanical-pencils.panl.properties |
0 commit comments