From 896a2bd4493c0fdc69c2d9b2a1ef996252fc2948 Mon Sep 17 00:00:00 2001 From: "Adam J. Arling" Date: Tue, 12 Dec 2023 14:23:36 +0000 Subject: [PATCH] Update URLs in Readme to be current --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 61592afc..9899dc0e 100644 --- a/README.md +++ b/README.md @@ -58,13 +58,13 @@ sam local start-api --host 0.0.0.0 --log-file dc-api.log The API will be available at: - `http://localhost:3000` (from your dev environment) -- `http://USER_PREFIX.dev.library.northwestern.edu:3000` (from elsewhere) +- `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000` (from elsewhere) - Don't forget to [open port 3000](https://github.com/nulib/aws-developer-environment#convenience-scripts) if you want to access it remotely ⚠️ Note the above URLs (which point to your local OpenSearch instance) need _full endpoints_ to resolve. For example: -- `http://USER_PREFIX.dev.library.northwestern.edu:3000/search` -- `http://USER_PREFIX.dev.library.northwestern.edu:3000/collections` +- `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000/search` +- `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000/collections` [View supported endpoints](https://api.dc.library.northwestern.edu/docs/v2/spec/openapi.html) Questions? [View the production API documention](https://api.dc.library.northwestern.edu/) @@ -84,8 +84,8 @@ View and edit information about a specific Work in the Index. 1. Open a local Meadow instance. 2. Find an `id` of a Work you'd like to inspect in the API. -3. View JSON response at `http://USER_PREFIX.dev.library.northwestern.edu:3000/works/[WORK_ID]` -4. View IIIF Manifest JSON response at `http://USER_PREFIX.dev.library.northwestern.edu:3000/works/[WORK_ID]?as=iiif` +3. View JSON response at `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000/works/[WORK_ID]` +4. View IIIF Manifest JSON response at `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000/works/[WORK_ID]?as=iiif` For help debugging/inspecting, JavaScript `console` messages are written to: `dc-api-v2/dc-api.log` @@ -141,8 +141,6 @@ bin/start-with-step aws stepfunctions create-state-machine --endpoint http://localhost:8083 --definition file://state_machines/av_download.json --name "hlsStitcherStepFunction" --role-arn arn:aws:iam::012345678901:role/DummyRole ``` - - ## Deploying the API manually - Symlink the `*.parameters` file you need from `tfvars/dc-api/` to the application root