Basic Configuration

Scoold is configured primarily through the configuration file scoold-application.conf. All configuration can be overridden with system properties or environment variables.

Scoold requires a persistent and direct connection to a Para backend. By default, Scoold will load its configuration from a file named scoold-application.conf but that file can be renamed to app.conf, for example, and then loaded with the system property -Dconfig.file=app.conf. The configuration can also be loaded from a ↗ JSON file or a URL.

Copy this Scoold basic configuration to your scoold-application.conf (edit the values if needed):

# the name of the application
scoold.app_name = "Scoold"
# the port for Scoold
scoold.port = 8000
# environment - "production" or "development"
scoold.env = "production"
# the public-facing URL where Scoold is hosted
scoold.host_url = "http://localhost:8000"
# the URL of Para - can also be "https://paraio.com"
scoold.para_endpoint = "http://localhost:8080"
# access key for your Para app
scoold.para_access_key = "app:scoold"
# secret key for your Para app
scoold.para_secret_key = "{secret}"
# the email or identifier of the admin user - check Para user object
scoold.admins = "admin@domain.com"
# Enable/disable password authentication
scoold.password_auth_enabled = true

Startup

On startup, Scoold tries to connect to Para every 10 seconds, 10 times in total. (default). If the connection is unsuccessful, the settings will not be persisted.

scoold.connection_retries_max = 10
scoold.connection_retry_interval_sec = 10

For an infinite number of attempts to connect to Para, set scoold.connection_retries_max to -1.

SMTP configuration

It’s recommended to configure SMTP as soon as possible in order for the transactional emails to work properly.

spring.mail.host = smtp.sendgrid.net
spring.mail.port = 587
spring.mail.username = apikey
spring.mail.password = your-sendgrid-api-key
spring.mail.properties.mail.smtp.auth = true
spring.mail.properties.mail.smtp.starttls.enable = true

Branding

scoold.show_branding = true
# Custom logo URL
scoold.logo_url = "https://cdn.mycompany.com/logo.png"
# Custom CSS (URL to a stylesheet)
scoold.stylesheet_url = "https://cdn.mycompany.com/scoold-custom.css"
# Welcome message on login page
scoold.welcome_message = "Welcome to MyCompany's knowledge base"

For details on all customization options, visit the page on Customization.

Configuration Reference For the complete list of configuration options, visit the configuration reference page.