Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 3.34 KB

README.md

File metadata and controls

74 lines (44 loc) · 3.34 KB
Raw

FIN Server Documentation

Fin Core

There are three services at the core of Fin:

  • Fedora
  • Redis
    • A key/value store Redis is used for storing sessions, admins, service signatures and available to all other local services to be leveraged for basic storage (ex: the basic-auth service uses Redis store username/password information).
  • Fin Server
    • A NodeJS/ExpressJS server that acts as a proxy to route Fin HTTP requests to desired services. The Fin server also adds endpoints for handling some auth functionality such as logout and admin administration.

Services

Fin is built using composable microservices. If you want to develop on or deploy Fin, this is recommended reading.

Service Documentation

FIN CLI

https://github.com/UCDavisLibrary/fin-cli

A command line interface and shell for interactive with Fin. Built using the fin-node-api the CLI provides functionality for interacting with Fin and Fedora. It provides a simple CLI for performing all Fedora HTTP API requests as well as working with Fin services, WebAC/acl the Fin way and authentication.

Install CLI (NodeJS w/ NPM Required)

npm install -g fin-cli

Administrators

Administrators are users that access the fedora component with webac disabled. This allows access to all parts of the fedora repository as well as access to admin only parts of the Fin server. If you want to add a new administrator to your system. This is accomplished with this commands. Note, this assumes you are running from a fresh Fin instance and uses the https://github.com/UCDavisLibrary/fin-cli

First we want to grant our Fin CLI temporary super user access. We can do this with the login commands --super-user flag:

fin login --super-user <username>

You will then be prompted for the servers jwt secret and jwt issuer. Provide those to the CLI and provide a username you want to login as (it can be anything, new containers will be created at this user).

Now that we are a super user you can add admins to the system.

fin acl add-admin quinn

This will give the user quinn admin access to the system. If you are using CAS authentication with a subdomain (ex: ucdavis.edu), then the command should be:

fin acl add-admin [email protected]

Which gives user [email protected] admin access to the system.

Finally, logout with fin logout. Now when you log back in as quinn or [email protected] the user will have admin permissions.

Fin Config (Environmental Variables)

See docs here

Demo

UC Davis DAMS Demo. A great quick start and overview of Fin services in action.

CORS

See Fin implementation details here

Browser Quirks

See docs here