Skip to content

MISC.md

Latest commit

 

History

History
39 lines (24 loc) · 1.62 KB

MISC.md

File metadata and controls

39 lines (24 loc) · 1.62 KB

Miscellaneous Info - Universal Connect Widget

Table of Contents

Sensitive Information

Please remember that secrets are passed through environment variables instead of hardcoded in the code files. Do not put any credentials in any of the code files. If you do so, it could get committed and leaked to the public. Use the provided .env files.

Deploying a Production Instance

For a production instance, it is easiest to use Docker. We provide docker files for both the server and the UI, along with a docker-compose file that runs all necessary containers, included Redis and ElasticSearch.

The simplest way to deploy this widget is via docker-compose, as shown below, however you can also use the dockerfiles directly.

Take a look at the docker-compose.yml file for more details on how it is set up.

docker compose up

That's it! If you have questions, please reach out to us at https://universalconnectproject.org/build/

Cached Data

This widget runs off of cached data, which is included in this repo, so that it doesn't rely on any UCP-hosted services in order to function.

In ./apps/server/cachedDefaults you will find files that are loaded into a redis cache. In the future these files will be used as a backup in case UCP-hosted services are down.

The following files need to be there for the widget service to function

  1. Preferences
  2. Institutions