README
¶
dp-frontend-search-controller
An HTTP service for the controlling of search API
Getting started
- Run
make debug
Run new search in the UI:
- run the web journey
- set
SearchRoutesEnabledtotrueandSearchABTestPercentageto100in the config of the dp-frontend-router
Dependencies
- generate default content with dp-zebedee-content
- dp-design-system
- dp-search-api
- Run Elasticsearch (version 2.4.2 runs on port 9200) via dp-compose
No further dependencies other than those defined in go.mod
Configuration
| Environment variable | Default | Description |
|---|---|---|
| API_ROUTER_URL | http://localhost:23200/v1 | The URL of the dp-api-router |
| BIND_ADDR | localhost:25000 | The host and port to bind to |
| DEBUG | false | Enable debug mode |
| DEFAULT_LIMIT | 10 | The default limit of search results in a page |
| DEFAULT_MAXIMUM_LIMIT | 50 | The default maximum limit of search results in a page |
| DEFAULT_MAXIMUM_SEARCH_RESULTS | 500 | The default maximum search results |
| DEFAULT_OFFSET | 0 | The default offset of search results |
| DEFAULT_PAGE | 1 | The default current page of search results |
| DEFAULT_SORT | relevance | The default sort of search results |
| ENABLE_CENSUS_TOPIC_FILTER_OPTION | false | Enable filtering on various census topics |
| GRACEFUL_SHUTDOWN_TIMEOUT | 5s | The graceful shutdown timeout in seconds (time.Duration format) |
| HEALTHCHECK_CRITICAL_TIMEOUT | 90s | Time to wait until an unhealthy dependent propagates its state to make this app unhealthy (time.Duration format) |
| HEALTHCHECK_INTERVAL | 30s | Time between self-healthchecks (time.Duration format) |
| NO_INDEX_ENABLED | false | If true then prevents most search engine web crawlers from indexing the search pages |
| PATTERN_LIBRARY_ASSETS_PATH | "" | Pattern library location |
| SITE_DOMAIN | localhost | |
| SUPPORTED_LANGUAGES | [2]string{"en", "cy"} | Supported languages |
Contributing
See CONTRIBUTING for details.
License
Copyright © 2020 - 2021, Office for National Statistics (https://www.ons.gov.uk)
Released under MIT license, see LICENSE for details.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
assets in locale and templates folders are converted into Go source code with go-bindata the data.go file in this package is auto generated through the generate-dev and generate-prod tasks in the Makefile
|
assets in locale and templates folders are converted into Go source code with go-bindata the data.go file in this package is auto generated through the generate-dev and generate-prod tasks in the Makefile |
|
features
|
|
Click to show internal directories.
Click to hide internal directories.