starlinglab / authenticated-attributes

Authenticated Attributes project by the Starling Lab
MIT License
6 stars 1 forks source link

Create HyperBee Gateway for UWAZI UI to make requests to #3

Closed katelynsills closed 1 year ago

katelynsills commented 1 year ago

User Story

As a casual user who chooses to trust Starling, I want to be able to read Starling's metadata about the images/.wacz files I have UWAZI, without having to create my own replication of Starling's Hyperbee instance.

AMS Ledger_2023-03-24_19-22-14

Methods

Paul Frazee has a tutorial on how to create a Node application that connects to HyperBee (we won’t be using the Hyperdrive part of the tutorial) As far as I can tell, it’s the same basic setup as any other Node app, just using Hyperbee as the db.

On the UWAZI side, UWAZI allows for custom page templates, so we can add our own JS to make requests to the Gateway without any alternations to production UWAZI. See Designing Your Website as a starting point. I (Kate) have tested this out locally.

Edit: Note that adding a script to the page in the section requires shipping a custom UWAZI. This was required for the wacz replay demo, which we want to include in our prototype UI, so it sounds like we will need to fork the repo anyways.

katelynsills commented 1 year ago

This was completed in #12. I'll follow up with another issue for creating a second gateway just for demo purposes (to emulate the user adding their own data and then the UI showing a mix from the two gateways). I'll also follow up with a task for mapping a string to the public key that signed the attributions, whether that be from certificates, PGP web of trust, or petnames.