Skip to content

Environmental variables

paulalbert1 edited this page Mar 22, 2024 · 3 revisions
Variable Optional Notes
NEXT_PUBLIC_RECITER_API_KEY Key to allow user to access Reciter endpoints. This should have been created when your Reciter application was deployed.
RECITER_API_BASE_URL Base URL for Reciter API endpoints, e.g., https://myInstitution.edu/. This should have been created when your Reciter application was deployed.
NEXT_PUBLIC_RECITER_TOKEN_SECRET Token secret for the Reciter APIs. This should have been created when your Reciter application was deployed.
NEXT_PUBLIC_RECITER_BACKEND_API_KEY This is an Authorization token used to secure API endpoints. The application contains its dedicated APIs within the src/pages/api directory, which are protected by an API key. To interact with these APIs, it's necessary to append an Authorization header containing the specified token in your requests.
RECITER_DB_NAME reciterdb database name, e.g. "reciterdb"
RECITER_DB_USERNAME reciterdb username, e.g., "admin"
RECITER_DB_PASSWORD reciterdb password
RECITER_DB_HOST reciterdb hostname, e.g., reciterdbmysql.absfse421.us-east-1.rds.amazonaws.com
RECITER_DB_PORT reciterdb port, e.g., "3306"
NEXT_PUBLIC_LOGIN_PROVIDER yes Options are "SAML" or nothing. If "SAML" is input, authenticating users are directed to the SAML identity provider. If not, the user is directed to login directly at Publication Manager's native login at "/login".
SMTP_HOST_NAME yes host name of SMTP server, e.g., email1234-smtp.us-east-1.amazonaws.com
SMTP_USER yes notifying users of new publications
SMTP_PASSWORD yes notifying users of new publications
SMTP_ADMIN_EMAIL yes notifying users of new publications
ASMS_DB_HOST yes used at WCM to track usage of Publication Manager application
ASMS_DB_NAME yes used at WCM to track usage of Publication Manager application
ASMS_DB_USERNAME yes used at WCM to track usage of Publication Manager application
ASMS_DB_PASSWORD yes used at WCM to track usage of Publication Manager application
ASMS_API_BASE_URL yes used at WCM to track usage of Publication Manager application
ASMS_USER_TRACKING_API_AUTHORIZATON yes used at WCM to track usage of Publication Manager application
Clone this wiki locally