Skip to content

Commit

Permalink
Merge pull request #787 from alphagov/documentation-update-for-finder…
Browse files Browse the repository at this point in the history
…-local

Update documentation For local finder setup
  • Loading branch information
minhngocd authored Oct 25, 2024
2 parents 63cb573 + 82d2b14 commit 4d078a7
Showing 1 changed file with 34 additions and 19 deletions.
53 changes: 34 additions & 19 deletions docs/how-tos/finder-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,53 +6,68 @@ finder with locally. The instructions below assume that you have "made" all of t
This has been tested predominantly using Specialist Publisher, but other publishing apps should work just as well.

1. Start your publishing app of choice, e.g. `govuk-docker up specialist-publisher-app`
2. Start the finder-frontend app: `govuk-docker up finder-frontend-app`
3. Create a router backend for finder frontend:

1. Start the finder-frontend app: `govuk-docker up finder-frontend-app`

1. Create a router backend for finder frontend:
```bash
curl http://router-api.dev.gov.uk/backends/finder-frontend -X PUT \
-H 'Content-type: application/json' \
-d '{"backend": {"backend_url": "http://finder-frontend.dev.gov.uk/"}}
```
4. Create a router backend for Search API:
1. Create a router backend for Search API:
```bash
curl http://router-api.dev.gov.uk/backends/search-api -X PUT \
-H 'Content-type: application/json' \
-d '{"backend": {"backend_url": "http://search-api.dev.gov.uk/"}}'
```
5. Create a router backend for frontend (this is needed to serve the root taxon created in step 8):
1. Create a router backend for frontend (this is needed to serve the root taxon created in step 8):
```bash
curl http://router-api.dev.gov.uk/backends/frontend -X PUT \
-H 'Content-type: application/json' \
-d '{"backend": {"backend_url": "http://frontend.dev.gov.uk/"}}'
```
6. Create a router backend for collections (this is needed to serve the test taxon created in step 9):
1. Create a router backend for collections (this is needed to serve the test taxon created in step 9):
```bash
curl http://router-api.dev.gov.uk/backends/collections -X PUT \
-H 'Content-type: application/json' \
-d '{"backend": {"backend_url": "http://collections.dev.gov.uk/"}}'
```
7. Publish special routes by running `govuk-docker run publishing-api-lite bundle exec rake publish_special_routes`.
8. Publish Search API's routes by
1. Publish special routes by running `govuk-docker run publishing-api-lite bundle exec rake special_routes:publish`.
1. Publish Search API's routes by
running `govuk-docker exec search-api-app bundle exec rake publishing_api:publish_special_routes`.
9. Publish the root taxon for GOV.UK: `govuk-docker run publishing-api-lite rake publish_homepage`
10. Publish a test taxon:

1. Publish the root taxon for GOV.UK: `govuk-docker run publishing-api-lite rake special_routes:publish_homepage`

1. Publish a test taxon:
```bash
govuk-docker run whitehall-lite rails taxonomy:populate_end_to_end_test_data
govuk-docker run whitehall-lite rails taxonomy:rebuild_cache
```
11. Publish your specialist finder or general finder page.
* For a specialist
finder: `govuk-docker exec specialist-publisher-app bundle exec rails publishing_api:publish_finder\[finder_name\]`
* For a general finder, e.g. the all content
finder: `govuk-docker exec search-api-app env FINDER_CONFIG=all_content_finder.yml bundle exec rake publishing_api:publish_finder`
12. Create the search

1. Create the search
indices: `govuk-docker exec search-api-app env SEARCH_INDEX=all bundle exec rake search:create_all_indices`
13. Create the publishing api RabbitMQ exchange so that Search API can listen for new content to

1. Create the publishing api RabbitMQ exchange so that Search API can listen for new content to
index: `govuk-docker exec publishing-api-app bundle exec rake setup_exchange`
14. Create the search API message

1. Create the search API message
queues: `govuk-docker exec search-api-worker bundle exec rake message_queue:create_queues`
15. Run `govuk-docker exec search-api-worker bundle exec rake message_queue:insert_data_into_govuk` to listen for

1. Run `govuk-docker exec search-api-worker bundle exec rake message_queue:insert_data_into_govuk` to listen for
messages. This is a long-running process, so you may want to start it in the background.
16. Publish a document. It should show up in the search results.

1. Publish your specialist finder or general finder page.
* For a specialist
finder: `govuk-docker exec specialist-publisher-app bundle exec rails publishing_api:publish_finder\[finder_name\]`
* For a general finder, e.g. the all content
finder: `govuk-docker exec search-api-app env FINDER_CONFIG=all_content_finder.yml bundle exec rake publishing_api:publish_finder`

1. Publish a document. It should show up in the search results.


0 comments on commit 4d078a7

Please sign in to comment.