# Buzzy settings ### Table of contents 1. [Basic settings](#basic-settings) 1. [Environment variables](#environment-variables) 2. [METEOR\_SETTINGS variables](#meteor_settings-variables) 1. [Server-only METEOR\_SETTINGS variables](#server-only-meteor_settings-variables) 2. [Public METEOR\_SETTINGS variables](#public-meteor_settings-variables) 3. [Map Variables](#map-variables) 1. [SPECTRUM\_SPATIAL variables](#spectrum_spatial-variables) 2. [INITIAL\_MAP\_COORDS variables](#initial_map_coords-variables) *** ### Basic settings Edit your `settings.json` or `.yml` file and enter the following information: #### Environment variables The following Environment variables need to be setup. How these are setup will depend on the deployment environment: Docker/Kubernetes/Galaxy etc. For solutions like Galaxy, these are included in the settings JSON. | Key | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ROOT\_URL | URL you are deploying Buzzy to, including `https://` | | MONGO\_URL | Enter your mongoDB credentials and URL | | MONGO\_OPLOG\_URL | Enter your mongoDB credentials and URL | | MAIL\_URL | Mail URL including `smtp://username:password@smtp-host-name:smtp-port` or `smtp://smtp-api-key@smtp-host-name:smtp port` . SMTPS connection is supported and requires extra parameters to handle TLS. Refer to [Node.JS documentation](https://nodejs.org/docs/latest/api/tls.html#tls_tls_connect_port_host_options_callback) | | METEOR\_SETTINGS | See table below | #### METEOR\_SETTINGS variables #### **Server-only METEOR\_SETTINGS variables** These are settings that are only accessible to the server. | Key | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | AWS\_BUZZY\_FILES | Your s3 file storage config | | MAIL\_URL | Enter your SMTP details (same as above) | | BUZZY\_ADMIN\_EMAIL | OPTIONAL: Enter Admin user email, used as the primary owner of the default Buzzes and resources that can be added to a Buzz | | BUZZY\_ADMIN\_IDS | OPTIONAL: Enter an array of Buzzy admin user IDs | | BUZZY\_LOGGING\_TOKEN | Token used for access to the Buzzy logging server. Must be the same in the buzzy-logging.yml | | DEFAULT\_OAUTH\_PROVIDERS | Details for the OAuth provider to be set up (e.g. IBM Connections) | | BUZZY\_CREATE\_DEFAULT\_ACCOUNTS | Default accounts created. Set isAdmin for these accounts to be considered the same as BUZZY\_ADMIN\_EMAIL. Make the email the same as one from the OAuth provider to be able to view and edit the provider settings | #### **Public METEOR\_SETTINGS variables** These are settings that are available to the client (browser or device/app). | Key | Description | | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | public/AWS\_BUZZY\_FILES | Public AWS details for files | | public/BUZZY\_DONOTREPLY\_EMAIL | A valid email address, required if you are using email for sending invitations to the platform, login tokens, password reset and notifications. Note, only the format of the email address needs to be valid, it does not need to be an active email account, for example ''. | | public/BUZZY\_CUSTOM/NAME | The name of the deployed app eg 'Buzzy'. | | public/BUZZY\_CUSTOM/NAME\_BUZZ | The term the app should use to refer to a (singular) 'Buzz', the core article type in Buzzy eg 'Buzz' | | public/BUZZY\_CUSTOM/NAME\_BUZZES | The term the app should use to refer to (multiple) 'Buzzes', the core article type in Buzzy eg 'Buzzes' | | public/BUZZY\_CUSTOM/APP\_URL\_IOS | OPTIONAL: URL of the app on the iOS app store. Renders at bottom of email notifications. | | public/BUZZY\_CUSTOM/APP\_URL\_ANDROID | OPTIONAL: URL of the app on the Android (Google Play) app store. Renders at bottom of email notifications. | | public/BUZZY\_CUSTOM/LOGO\_MAIN | OPTIONAL: URL of your main logo. Renders in the masthead and is resized down to fit into a 192x28 area. **Format:** a \`.png\` file with a transparent background; the logo should be light to suit rendering on a dark background. Note that it needs to be horizontal in format - due to the size restrictions, vertical or square formats don't work well at all. | | public/BUZZY\_CUSTOM/LOGO\_MAIL | **DEPRECATED**: Use [Email Customization](https://docs.buzzy.buzz/working-with-buzzy/buzzy-deployment-and-app-stores/email-customization) instead. URL of the logo used in system and notification emails. | | public/BUZZY\_CUSTOM/LOGO\_MAIL\_WIDTH | **DEPRECATED**: Use [Email Customization](https://docs.buzzy.buzz/working-with-buzzy/buzzy-deployment-and-app-stores/email-customization) instead. Width of the email logo. | | public/BUZZY\_CUSTOM/LOGO\_MAIL\_HEIGHT | **DEPRECATED**: Use [Email Customization](https://docs.buzzy.buzz/working-with-buzzy/buzzy-deployment-and-app-stores/email-customization) instead. Height of the email logo. | | public/BUZZY\_CUSTOM/EMAIL\_FOOTER | **DEPRECATED**: Use [Email Customization](https://docs.buzzy.buzz/working-with-buzzy/buzzy-deployment-and-app-stores/email-customization) instead. Optional content to be included in emails as a footer. | | public/BUZZY\_CUSTOM/FAVICON | OPTIONAL: Escaped html string that is inserted in the app html `head` to define a favicon. The assets (eg icon files, svg, xml, webmanifest etc) will need to be hosted somewhere and referred to here via absolute urls. Tip: generating the required assets and markup for a comprehensive favicon suite is easiest via a service such as [Realfavicongenerator](http://realfavicongenerator.net/) | | public/BUZZY\_CUSTOM/PROMO | OPTIONAL: Custom promo text (in footer of emails) - appears above EMAIL\_FOOTER and app store links (APP\_URL\_IOS and APP\_URL\_ANDROID) | | public/BUZZY\_CUSTOM/PROMO\_URL | OPTIONAL: Adds a 'Learn more' link after the Promo text. Leave blank to omit. | | public/BUZZY\_CUSTOM/SPLASH\_IMAGE | REDUNDANT: Old splash image used prior to login on mobile devices only. Not used. | | public/BUZZY\_CUSTOM/WELCOME\_IMAGE | OPTIONAL: Optional welcome image to use as background at end of onboarding sequence. Text and links will render over this. | | public/BUZZY\_CUSTOM/INVITE\_TEAM\_MESSAGE | OPTIONAL: Message to use in email notification when inviting a new user to a team. If blank, defaults to: '(Username) has invited you to join a (Appname) team': '(Username) has invited you to join a (Appname) team' | | public/BUZZY\_CUSTOM/INVITE\_TEAM\_BUTTON\_TEXT | OPTIONAL: Text to use in call-to-action button after INVITE\_TEAM\_MESSAGE eg 'Accept the invite'. If blank, defaults to: 'Join (Appname)' | | public/BUZZY\_CUSTOM/INVITE\_BUZZ\_TEXT | OPTIONAL: Message to use in email notification when inviting a user to a NEW Buzz or resource. If blank, defaults to 'has invited you to' (username and avatar appear before this phrase). For existing Buzzes or resource items, the message simply reads 'updated' (preceded by username and followed by details). | | public/BUZZY\_CUSTOM/INVITE\_CLICK\_TO\_VIEW\_TEXT | REQUIRED: Message to use in email notification when asking a user to view a NEW Buzz or resource. (Should be optional but no fallback exists?). | | public/BUZZY\_CUSTOM/SUPPORT\_EMAIL | OPTIONAL: Email address to receive support requests | | public/BUZZY\_CUSTOM/CUSTOM\_NAV | OPTIONAL: Allows control over the links and labels that appear in the app navigation. Some items include urls | | public/BUZZY\_CUSTOM/COMMENT\_LIMIT | OPTIONAL: Limit the number of comments that are retrieved at a time for a user when viewing comments in a Buzz | | public/BUZZY\_CUSTOM/ACTIVITY\_LIMIT | OPTIONAL: Limit the amount of alerts/notifications that are retrieved at a time for a user | | public/BUZZY\_CUSTOM/MICROAPPDATA\_LIMIT | OPTIONAL: Limit the number of microapp results or submissions that are retrieved at a time for a user | | public/BUZZY\_CUSTOM/DEFAULT\_LIMIT | OPTIONAL: TBD | | public/BUZZY\_CUSTOM/RECENT\_LIMIT | OPTIONAL: Limit the number of recent Buzzes that are retrieved at a time on the suers home page | | public/BUZZY\_TEMPLATE\_SERVER | OPTIONAL: URL to a server that will house or deliver your Buzzy templates | | public/GOOGLE\_MAPS\_ENABLED | OPTIONAL: specifies using Google Maps API, see also Map Variables | | public/GOOGLEBROWSER\_API\_KEY | OPTIONAL: needed for using Google Maps API, see also Map Variables | | public/INITIAL\_MAP\_COORDS | OPTIONAL: Set the default address when using the Location field. Include cordinates with formatted address field. Buzzy uses [Open Street Maps](https://www.openstreetmap.org/) and make sure to add "coordinates" with the order Longitude first and Latitude next. | #### Map Variables Map variables are used to configure the Advanced map. #### **SPECTRUM\_SPATIAL variables** These are the settings available to configure the Spectrum Spatial Mapping API | Key | Description | | ------- | ------------------------------------------------------------------- | | enabled | True if using Spectrum Spatial as the provider for the Advanced Map | | apiURL | The URL for the Spectrum Spatial Mapping Service | | key | Precisely Spectrum Spatial API key | | secret | Precisely Spectrum Spatial encryption secret | #### **INITIAL\_MAP\_COORDS variables** These are the settings available to configure Map location defaults. | Key | Description | | ---------------- | --------------------------------- | | formattedAddress | Initial full address | | mainAddressLine | Street Info | | addressLastLine | City, State/Province, Postal Code | | country | Three letter country abbreviation | | geometry | GeoJSON point to centre the map | *** --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.buzzy.buzz/advanced-deployment-settings/installation/buzzy-settings.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.