Settings keys
Generated from AdministrableConfig::registerConfig calls in api/packages
Packages register config keys with AdministrableConfig::registerConfig(key, rules, public, readonly) (package settings). Registered keys can be changed per tenant in the admin panel (Settings) and override the config file value; public keys are returned to unauthenticated clients by GET /api/config, the others only to administrators. Keys shown with <name> are built in a loop in the code.
Package: auth
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_auth.registration |
required, string, in: . implode(,, SettingStatusEnum::getValues()) | yes | |
ulams_auth.account_must_be_enabled_by_admin |
required, string, in: . implode(,, SettingStatusEnum::getValues()) | yes | |
ulams_auth.auto_verified_email |
required, string, in: . implode(,, SettingStatusEnum::getValues()) | yes | |
ulams_auth.return_url |
required, url | yes | |
ulams_auth.socialite_remember_me |
required, boolean | yes | |
ulams_auth.token_expiration_minutes |
required, integer | no | |
services.facebook.client_id |
nullable, string | no | |
services.facebook.client_secret |
nullable, string | no | |
services.facebook.redirect |
nullable, url | no | |
services.google.client_id |
nullable, string | no | |
services.google.client_secret |
nullable, string | no | |
services.google.redirect |
nullable, url | no |
bulk-notifications
Section titled “bulk-notifications”Package: bulk-notifications
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_bulk_notifications.push.service_account |
json | no | |
ulams_bulk_notifications.push.base_redirect_url |
string | no |
Package: cart
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_cart.min_product_price |
required, numeric, min:0 | yes |
course-access
Section titled “course-access”Package: course-access
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_course_access.auto_accept_access_request |
required, string, in: . implode(,, SettingStatusEnum::getValues()) | yes |
courses
Section titled “courses”Package: courses
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_courses.platform_visibility |
required, string, in: . implode(,, PlatformVisibility::getValues()) | yes | |
ulams_courses.reminder_of_deadline_count_days |
integer, min: 1 | yes | |
ulams_courses.course_visibility |
required, string, in: . implode(,, CourseVisibilityEnum::getValues()) | yes |
Package: demo
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_demo.<key> |
nullable | yes | yes |
example-plugin
Section titled “example-plugin”Package: example-plugin
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_example_plugin.greeting |
required, string, max:200 | yes |
images
Section titled “images”Package: images
| Key | Rules | Public | Read-only |
|---|---|---|---|
images.private.rate_limiter_status |
required, string, in: . implode(,, PackageStatusEnum::getValues()) | no | |
images.private.rate_limit_global |
required, numeric | no | |
images.private.rate_limit_per_ip |
required, numeric | no |
interactive
Section titled “interactive”Package: interactive
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_interactive.enabled |
required, boolean | yes | |
ulams_interactive.allow_network |
required, boolean | yes |
invoices
Section titled “invoices”Package: invoices
| Key | Rules | Public | Read-only |
|---|---|---|---|
invoices.date.pay_until_days |
required, integer | yes | |
invoices.currency.code |
required, string | yes | |
invoices.currency.fraction |
required, string | yes | |
invoices.currency.symbol |
required, string | yes | |
invoices.seller.attributes.name |
required, string | yes | |
invoices.seller.attributes.address |
required, string | yes | |
invoices.seller.attributes.code |
required, string | yes | |
invoices.seller.attributes.vat |
required, string | yes | |
invoices.seller.attributes.phone |
nullable, string | yes | |
invoices.seller.attributes.SWIFT |
nullable, string | yes |
Package: jitsi
| Key | Rules | Public | Read-only |
|---|---|---|---|
jitsi.package_status |
nullable, string, in: . implode(,, PackageStatusEnum::getValues()) | no | |
jitsi.jitsi_host |
nullable, string | yes | |
jitsi.app_id |
nullable, string | no | |
jitsi.secret |
nullable, string | no | |
jitsi.jaas_host |
nullable, string | yes | |
jitsi.aud |
nullable, string | no | |
jitsi.iss |
nullable, string | no | |
jitsi.kid |
nullable, string | no | |
jitsi.private_key |
nullable, string | no | |
jitsi.sub |
nullable, string, false | yes | |
jitsi.recording |
nullable, boolean, false | yes |
mailerlite
Section titled “mailerlite”Package: mailerlite
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_mailer_lite.package_status |
required, string, in: . implode(,, PackageStatusEnum::getValues()) | no | |
ulams_mailer_lite.api_key |
required, string | no | |
ulams_mailer_lite.newsletter_field_key |
required, string | no | |
ulams_mailer_lite.group_registered_group |
required, string | no | |
ulams_mailer_lite.group_order_paid |
required, string | no | |
ulams_mailer_lite.group_left_cart |
required, string | no |
mattermost
Section titled “mattermost”Package: mattermost
| Key | Rules | Public | Read-only |
|---|---|---|---|
mattermost.package_status |
required, string, in: . implode(,, PackageStatusEnum::getValues()) | no | |
mattermost.servers.default.host |
required, string | yes | |
mattermost.servers.default.login |
required, string | no | |
mattermost.servers.default.password |
required, string | no |
payments
Section titled “payments”Package: payments
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_payments.drivers.stripe.enabled |
required, boolean | yes | |
ulams_payments.drivers.stripe.secret_key |
required, string | no | |
ulams_payments.drivers.stripe.publishable_key |
required, string | yes | |
ulams_payments.drivers.stripe.webhook_secret |
nullable, string | no | |
ulams_payments.drivers.przelewy24.enabled |
required, boolean | yes | |
ulams_payments.drivers.przelewy24.live |
required, boolean | no | |
ulams_payments.drivers.przelewy24.merchant_id |
required, string | no | |
ulams_payments.drivers.przelewy24.pos_id |
required, string | no | |
ulams_payments.drivers.przelewy24.api_key |
required, string | no | |
ulams_payments.drivers.przelewy24.crc |
required, string | no | |
ulams_payments.drivers.revenuecat.enabled |
required, boolean | yes | |
ulams_payments.default_gateway |
required, string, in:Free,Stripe,Przelewy24 | yes | |
ulams_payments.default_currency |
required, string, in: . implode(,, Currency::getValues()) | yes |
pencil-spaces
Section titled “pencil-spaces”Package: pencil-spaces
| Key | Rules | Public | Read-only |
|---|---|---|---|
pencil_spaces.api_url |
string | no | |
pencil_spaces.api_key |
string | no |
questionnaire
Section titled “questionnaire”Package: questionnaire
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_questionnaires.new_answers_visible_by_default |
required, boolean | yes |
Package: tasks
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_tasks.notifications.overdue_period |
integer | no |
templates-email
Section titled “templates-email”Package: templates-email
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_templates_email.mjml.use_api |
required, bool | no | |
ulams_templates_email.mjml.api_id |
required, string | no | |
ulams_templates_email.mjml.api_secret |
required, string | no | |
ulams_templates_email.mjml.default_template |
required, string, new MjmlRule() | no |
templates-sms
Section titled “templates-sms”Package: templates-sms
| Key | Rules | Public | Read-only |
|---|---|---|---|
sms.default |
required, string, in: . implode(,, SmsDriversEnum::getValues()) | no | |
sms.drivers.requestbin.path |
string | no | |
sms.drivers.twilio.sid |
string | no | |
sms.drivers.twilio.token |
string | no | |
sms.drivers.twilio.from |
string | no |
topic-type-gift
Section titled “topic-type-gift”Package: topic-type-gift
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_gift_quiz.max_quiz_time |
required, integer, min:1 | no |
Package: video
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_video.bitrates |
array | no | |
ulams_video.enable |
boolean | no | |
ulams_video.non_strict_value |
boolean | no |
youtube
Section titled “youtube”Package: youtube
| Key | Rules | Public | Read-only |
|---|---|---|---|
services.youtube.refresh_token |
nullable, string | no | |
services.youtube.client_id |
nullable, string | no | |
services.youtube.client_secret |
nullable, string | no | |
services.youtube.api_key |
nullable, string | no | |
services.youtube.redirect_url |
nullable, string | no |