Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Gumban committed Jul 15, 2020
1 parent 0ea3d92 commit d64a870
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,16 @@ The project uses the node [config](https://www.npmjs.com/package/config) package
The project supports the following authentication strategies:

- None (Default)
- MarkLogic: Koop relies on MarkLogic for authenticating user credentials. Users must have a valid MarkLogic server user account.
- Direct File:
- MarkLogic
- File-based

#### No Authentication

All Koop services will be publicly accessible. Koop will still need valid MarkLogic credentials to communicate with MarkLogic. See `config/default.json` for an example.

#### MarkLogic Authentication

This uses a _direct authentication_ pattern similar to [Koop-Auth-Direct-File](https://github.com/koopjs/koop-auth-direct-file), with MarkLogic being responsible for authenticating user credentials. The user credentials supplied must match a valid MarkLogic server user account.
This uses a _direct authentication_ pattern similar to [Koop-Auth-Direct-File](https://github.com/koopjs/koop-auth-direct-file), with MarkLogic being responsible for authenticating user credentials. The credentials supplied must match a valid MarkLogic server user account.

To setup, add an `auth` section to your `config/FILENAME.json`, for example:

Expand All @@ -95,7 +95,7 @@ To setup, add an `auth` section to your `config/FILENAME.json`, for example:
| secret | Used to verify JSON web tokens | string | auto-generated UUID |
| tokenExpirationMinutes | The validity of tokens in minutes | Number | 60 |

#### Direct File Authentication
#### File-based Authentication

This uses the [Koop-Auth-Direct-File](https://github.com/koopjs/koop-auth-direct-file) module for authentication. Check out its [official project page](https://github.com/koopjs/koop-auth-direct-file) for more information.

Expand Down

0 comments on commit d64a870

Please sign in to comment.