Skip to content

Configuration Overview

Adrian Preuß edited this page Jan 10, 2018 · 6 revisions

On your config.php you have lot's of settings. Here an detailed overview:

💼 Database

Name Default Type Description
DATABASE_HOSTNAME localhost String The name of your MySQL-Server
DATABASE_PORT 3306 Integer The port of your MySQL-Server
DATABASE_NAME <NAME> String The database on your MySQL-Server
DATABASE_USERNAME <USER> String The username of your MySQL-Account
DATABASE_PASSWORD <PASS> String The passworf of your MySQL-User

🍬 Improvements

Name Default Type Description
CHARSET_OUTPUT UTF-8 String Output encoding for the API
CHARSET_DATABASE utf8 String Encoding of your MySQL-Server
DEBUG false Boolean Enable/Disable debug mode
PRETTY_OUTPUT false Boolean This option is only for debugging a nice-to-have! If you're using the API on productive systems, disable it to save lot's of memory...

🚸 Security

Name Default Type Description
HTTPS_ONLY true Boolean Check if the API-Request is only via https:// available
USERAGENT_APPSERVER true Boolean Check if the Request contains a valid UserAgent
APPSERVER_VERSIO true Boolean Check if the Request contains a valid AppServer version.
NOTE: This option has no affects if USERAGENT_APPSERVER is disabled!
CHATSERVER_VERSION true Boolean Check if the Request contains a valid ChatServer version.
NOTE: This option has no affects if USERAGENT_APPSERVER is disabled!
ALLOWED_CHATSERVERS false Comma-Separated list Check if the Request comes from allowed ChatServers. More Informations
ALLOWED_DEVELOPERS true Boolean Check allowed developers.
NOTE: All possible/whitelisted user-id's must be defined in your knuddelsAccess.txt More Informations
ALLOWED_CHANNELS false Boolean Check allowed channels.
NOTE: All possible/whitelisted channels's must be defined in your knuddelsAccess.txt More Informations
ALLOWED_APPS false Boolean Check allowed Apps.
NOTE: All possible/whitelisted UserApps must be defined in your knuddelsAccess.txt More Informations