Buzzy settings
Buzzy relies on a series of settings or config options that should be defined in a .json or .yml file. Not all are required for a basic deployment.
Table of contents
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 |
| 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 'donotreply@yourdomain.com'. |
| 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 | OPTIONAL: URL of the logo used in system and notification emails. Format: a `.gif`, `.jpg` or `.png` file with a white or transparent background; the logo should be dark to suit rendering on a light background. With wide landscape logos, a max width of 240px is recommended. With vertical logos, a max height of 120px is recommended, but for standard-ish rectangle logos (eg 4:3 ratio etc) keep it very small - the default Buzzy one is 60x25px. |
| public/BUZZY_CUSTOM/LOGO_MAIL_WIDTH | REQUIRED WITH LOGO_MAIL: Width of the email logo. Should correspond to actual image width (don't rely on variables to resize down from a larger image). |
| public/BUZZY_CUSTOM/LOGO_MAIL_HEIGHT | REQUIRED WITH LOGO_MAIL: Height of the email logo. Should correspond to actual image height (don't rely on variables to resize down from a larger image). |
| public/BUZZY_CUSTOM/EMAIL_FOOTER | OPTIONAL: 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 |
| 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 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 |