file-management-service v3.0.0

File Management Service

Service for uploading and downloading files from S3. Written in Node.js.

See https://confluence.checkit.net/display/appteam/File+Management+Service for the design document.

By default, the application is configured to start on port 4002.

JavaScript Tools

npm install -g typescript
npm install -g typeorm
yarn

Starting the Application

yarn start
yarn run unit-tests
yarn run api-tests

Environment Variables

• DEBUG: Value for debug within the application.
• PG_CHECKIT_USER: User that the application will use to connect to your CheckIt Postgres database.
• PG_CHECKIT_PASSWORD: Password that the application will use to connect to your CheckIt Postgres database.
• PG_CHECKIT_ADDR: The address of the Postgres database server.
• PG_CHECKIT_PORT: Port the application will use to connect to the database server.
• PG_CHECKIT_DATABASE: The database within the database server that will be used by this service.
• FILE_MANAGEMENT_S3_BUCKET: Bucket name e.g. local-file-management-service.
• CHECKITDB_URI: MongoDB connection string to checkit database.
• OAUTH2_PUBLIC_KEY: Keycloak public key.
• OAUTH2_CLIENT_ID: Web UI client id in keycloak.
• SENTRY_KEY: Sentry client key.
• S3_TEMP_URL_EXPIRATION: How long temp urls last.
• FRONTEND_HOME_URI: Host and port where the web ui is listening to. Used for CORS.
• KEEPALIVE_TIMEOUT: Keep alive timeout value in milliseconds.
• CHECKIT_ENV: Defines environment type which defines how to read AWS parameter store vars. ('local' = read local environment).
• NEW_RELIC_LICENSE_KEY: New Relic license key needed for logging to new relic.
• NEW_RELIC_APP_NAME: The application name used to log into new relic.
• AWS_DEFAULT_REGION: eu-west-1 by default.

Cross Origin Resource Sharing - CORS

Service is configured to only allow connections from the Control Centre by the FRONTEND_HOME_URI variable.