Settings

Settings marked as required will generate warnings if left empty.

General

Setting	Description
flock_name_public	The public name of the database (flock), e.g. “My Example Membership Organisation”. Required.
flock_name_public_short	The short public name, e.g. “Example”.
address_lines	List of address lines for the organisation. Required.
charity_number	Registered charity number.
company_number	Registered company number.
contact_email	Contact email for the organisation, e.g. info@example.com. Required.
invoice_email	Renamed from invoiceEmail, e.g. billing address.
phone	Public phone number of the organisation. Required.
postal_code	Zip or postal code of the organisation. Required.
website	URL for the website of the organisation. Required.
facebook	Social link.
instagram	Social link.
linkedin	Social link.
twitter	Social link.
youtube	Social link.

Brand

Setting	Description
flock_logo	Logo (PNG / SVG format preferred). Required.
flock_logo_monochrome	Monochrome logo (PNG / SVG format preferred). Used in the footer.
flock_logo_square	Square logo (PNG / SVG format preferred). Used for email, invoices and receipts.
flock_banner_image	Banner (long horizontal image) (PNG / SVG format preferred).
name_in_logo	Is the name of the flock in the logo? (If so then the name is not shown beneath the logo.)
hide_logo	Hides the logo.

Palette settings

Setting	Description
app_colour	Renamed from mainColor. The base colour which sheepApp will use to generate your theme. This actual colour may not appear anywhere if the front-end code decides it is too dark/bright. Required.
brand_colour	Renamed from brandColor. The exact value which will be used in your footer. Required.
header_font_treatment	Renamed from headerCase. Font treatment, e.g. “uppercase”.

Pro Account Fields

Setting	Description
app_header_font	Renamed from headerFont. Font to be used in header. Required. Pro accounts only.
app_font	Renamed from mainFont. Body font. Required. Pro accounts only.
customThemeOverride	An override palette (see below). Pro accounts only.

Custom Theme Override

All values must be provided unless otherwise specified:

Setting	Description
base	Main theme colour. Used for e.g. header text, icons, buttons.
light1	Approx 10% lighter (when auto generated). Used very sparingly.
light2	Approx 25% lighter (when auto generated). Not currently used.
light3	Approx 40% lighter (when auto generated). Background colour used for e.g. top nav, missing images.
light4	Approx 50% lighter (when auto generated). Disabled elements, e.g. unclickable buttons, unavailable venue slots.
dark	Approx 20% darker (when auto generated). Primarily used for hover elements.
navText	The colour used for text in top nav (usually black). Optional.
footerText	The colour used for text in the branded fat-footer (usually white). Optional.

Financial

Setting	Description
default_currency	Default currency. Required.
financial_year_day	Start of the financial year day of the month, e.g. 8 for 8th.
financial_year_month	Start of the financial year month, e.g. 4 for April.
lower_tax_rate	Lower tax rate (usually VAT). Default 0.05. Required.
standard_tax_rate	Standard tax rate (usually VAT). Default 0.20. Required.
mandate_scope	What can the DD mandate be used for: all_transactions, donations, membership, tickets.

Miscellaneous

Setting	Description
connections	List of connection roles to show in user interface.
disable_auto_tags	Turn off auto tagging: true / false.
gift_aid_rate	Gift Aid rate (for UK based Gift Aid). Default 0.25.
gift_aid_scope	What should have gift aid automatically applied (if a gift aid declaration is on file): all_transactions, donations, membership, tickets.
interest_groups	The areas of interest that a user can choose from.
locked_tags	List of tags which are “locked” and cannot be removed by users with lower permission levels.
team_roles	The team/group roles supported by your teams.

Config

Setting	Description
availableOptions	consent (privacy, GDPR consent capture), donations (appeals), events, giving (gift aid), membership, messages (view messages sent in-app or via email), payments, teams (groups/teams), venues (space reservations).
newVerify	On by default.
health	true / false.
interests	true / false. Ask the member to select their areas of interest.
invoices	true / false.
qualifications	true / false.

App Text, Label and Content Customisation

Setting	Description
hideLogo	true / false.
hideLoginCTA	true / false.
signupline	e.g. “Become a member today.”
loginIntroText	Custom text for login process.
banner_image	URL of banner image.
consentCTA	Markdown text. Call to action for section.
donationsCTA	Markdown text. Call to action for section.
eventsCTA	Markdown text. Call to action for section.
givingCTA	Markdown text. Call to action for section.
membershipCTA	Markdown text. Call to action for section.
teamsCTA	Markdown text. Call to action for section.
eventsReturnAddress	URL for the website used for return to website link (from events).
websiteReturnAddress	URL for the website used for return to website link. Required.

Membership

Setting	Description
auto_membership_number	Auto membership numbering: true / false.
membership_grace_period	Period after a membership lapses when a member can renew. Default 1.
membership_renew_window	Period before a membership lapses when a member can renew.
random_auto_membership_number	Use random numbers for membership numbering.
initial_membership_number	Starting membership number when auto_membership_number is turned on.

Membership sub-settings

Setting	Description
enabled	(membership_enabled) true / false.
allowMultiple	(membership_allow_multiple) Allow a member to have multiple active memberships.
paymentOptions	List of available payment options: gocardless_mandate, stripe, payLater.
maxPlansToShow	(membership_max_plans_to_show) Number of membership plans to show on first screen.
onFinishPath	(membership_on_finish_path) Relative app URL to redirect the user to on completion.
noSignup	(membership_enable_new_registrations) true / false.
certificates	(membership_certificates) Membership certificates: true / false.
certificateTemplate	(membership_certificate_template) Custom membership certificate.
membershipCards	(membership_cards) true / false.
documentsActiveOnly	(membership_documents_active_only) true / false.
documentsPaidOnly	(membership_documents_paid_only) true / false.
changeOnRenew	(membership_change_on_renew) Allow the member to change plans on renewal: true / false.
linkedWord	(membership_linked_member_noun) The word to use when referring to linked members.

Membership Text Customisation

Setting	Description
membershipIntro	(membership_intro_text) e.g. “Join today in 4 simple steps.”
signupline	(membership_signupline) e.g. “Become a member”.
confirmIntroText	(membership_confirm_intro_text) e.g. “Please double check the details and then click confirm”.
updateThankText	(membership_thank_text_renew) e.g. “Thank you for renewing…”.
thankText	(membership_thank_text_new) Text to show when done. Opportunity to ask the member to complete an additional process.
almostDoneButtonText	(membership_almost_done_button_text) Override text, e.g. “Skip”.
onFinishName	(membership_on_finish_name) Header text to show when done.
interestsIntro	(membership_interests_intro) Intro text for when interests are enabled.
questions	(membership_questions) List of strings.
questionDescriptions	(membership_question_descriptions) List of question descriptions.
steps	Four labels to override the default joining steps.
stepIntroText	Four paragraphs to override the default joining step intro text.

Pay Later settings

Setting	Description
linkText	Override text for pay later / invoices, e.g. “Request an invoice”.

Registration Switches

All are true / false settings:

Setting	Default	Description
addressRequired	false	Require address.
withDOB	false	Include DOB in registration form.
includeDOB	true	Include DOB field.
requireDOB	true	Require DOB.
hideOptionalFields	false	Hide optional fields.
hideOccupation	false	Hide occupation field.
withTitle	false	Include title in registration form.
includeEthnicity	false	Include ethnicity field.
requireEthnicity	false	Require ethnicity.
includeEmergencyContact	false	Include emergency contact.
requireEmergencyContact	false	Require emergency contact.
includeEmergencyContact2	false	Include second emergency contact.
requireEmergencyContact2	false	Require second emergency contact.
excludeAddress	false	Exclude address fields.
onlyBasicDataRequired	true	Only basic data required.
withSource	false	Include source field.
withBio	false	Include bio field.
withKnownAs	false	Include known-as field.
withEmployer	false	Include employer field.
requireSource	false	Require source.
requireBio	false	Require bio.
requireEmployer	false	Require employer.

Partners

Setting	Values	Description
discourse_usage	on, off, paused	Forum.
dial9_usage	on, off, paused	VOIP provider.
email_dropbox_usage	on, off, paused	Sheep system for importing emails from a named IMAP account.
eventbrite_usage	on, off, paused	Box office.
gocardless_usage	on, off, paused	Direct debit payments.
loqate_usage	on, off, paused	Address auto complete.
mailchimp_usage	on, off, paused	Mailing lists.
stripe_usage	on, off, paused	Credit card payments.
xero_usage	on, off, paused	Accounting software.

Partner settings values

Value	Description
on	Partner is (or should be) active. Notices will be issued for problems or missing config.
off	Partner is not in use.
paused	Partner is normally active but has been paused.

Privacy

Settings within privacy:

Setting	Description
privacy_policy_url	Full URL to client privacy policy. Required.
include_form	Include a privacy form: true / false.

Forms

Settings within application:

Setting	Description
noun	Noun to describe the user completing the form, e.g. “Volunteer” or “Applicant”.
nounPlural	Plural of noun.
withdrawPara	Text to show for users withdrawing an application.
thankPara	Text to show when an application has been submitted.
introPara	Intro text to show for applications.
consentPara	Consent text to show for applications.