access-management v1.0.0

Folio Access Mangement API

A .NET Core API that manages user access to Folio.

Getting Started

Database

This API uses migrate-mongo, a Node.js application, for managing database state changes. An application using migrate-mongo is located in the database folder. To get started with Folio database migrations, run npm install from the database directory then use the npm run migrate script. Please refer to the migrate-mongo GitHub for CLI usage information.

The migrate-mongo library uses the migrate-mongo-config.js file for managing database connections. In order to use locally, change the config.mongodb.url and config.mongodb.databaseName properties to point to your local database. Be careful to not check this file in since Octopus Deploy requires the {{connectionString}} and {{database}} regex to inject environment configuration.

If no migrations are added to the project, create the migrations directory and run the npm run migrate create <migration-name> command.

Docker

Running the Container

The Access Management API uses docker-compose which contains the following containers:

• accessmanagement.api
• accessmanagement.mongo

To debug using Visual Studio, set the docker-compose project as your StartUp project. This will enable the Debug run option 'Docker Compose'.

To run the app using the Docker CLI, use the docker compose -f docker-compose.yml -f docker-compose.override.yml up command in the directory where docker-compose.yml lives. The docker-compose.override.yml file contains configuration for a development build.

When using Docker for Windows configure your local drive as a shared drive to enable Docker volumes. Docker Shared Drives

Configuring the Database

The database containers use docker volumes that will persit the data for the container. To connect to that database use the following ports:

• accessmanagement.mongo : 27020