System Configuration
The System Configuration is handled by the install script. If the install fails, edit the /system/Example-Config.php using the below as a guide, then rename the file to /system/Config.php.
Site URL
The SITE_URL is the root url of the project. UserCandy uses this when displaying links within the site to insure the url does not get overlapped and reduces possible errors. SITE_URL can be called anywhere within the project.
Code
/* Define Site Url Address */
define('SITE_URL', 'https://localhost/');
Default Template
The DEFAULT_TEMPLATE lets the system know which system template to load. These are located in the /system/templates/ folder.
Code
/* Default Template */
define('DEFAULT_TEMPLATE', 'Default');
Language Code
The LANGUAGE_CODE lets the system know which language file to load by default. These are located in the /system/templates/ folder.
Code
/* Default Language Code */
define('LANGUAGE_CODE', 'En');
Session Prefix
The SESSION_PREFIX gives the systems session a unique value so that it does not get mixed up with other projects within your server.
Code
/* Default Session Prefix */
define('SESSION_PREFIX', 'uc_');
Database Configuration
The Database Settings are required for the Framework to connect to the database and work properly. The UserCandy Framework will not work without a database connected. If for any reason the Install Scrip failed and the Config.php file is configured manually, the database.sql file must be imported into the database. Check the UserCandy Forums for help.
Code
/**
* Database engine default is mysql.
*/
define('DB_TYPE', 'mysql');
/**
* Database host default is localhost.
*/
define('DB_HOST', 'uc_db_host');
/**
* Database name.
*/
define('DB_NAME', 'uc_db_name');
/**
* Database username.
*/
define('DB_USER', 'uc_db_user');
/**
* Database password.
*/
define('DB_PASS', 'uc_db_pass');
/**
* PREFIX to be used in database calls default is uc_
*/
define('PREFIX', 'uc_');
Admin Panel System Settings
Once your site is connected to the database, there are more settings that can be configured within the AdminPanel -> Main Settings page. There are tool tips that can be clicked within each setting for further information.
The following settings are configured within the
Main Settings page.
- Site Title
- Site Description
- Site Keywords
- Google reCAPTCHA Keys
- Site Wide Message
The following settings are configured within the
Advanced Settings page.
- Site Registration Settings
- Site User Login Settings
- Members Settings
- Site Time Zone Settings
- Paginator Limits
- Messages Plugin Settings (if installed)
- Max Profile Image Size
- Main Home Page Settings
E-Mail Settings contains the settings the framework needs to connect to a smtp server to send email notifications.
Pages Permissions is the first place to go when a new page is created within the /custom/pages/ folder. The system will automatically detect the new pages and add them to the database. Once added the
Page Permissions can then be edited. Anytime a new page is detected, a link will be automatically added to the nav bar. Nav Bar links can be edited within the
Site Links page in the AdminPanel.
There are many more settings within the AdminPanel that are not explained above, but the ones listed above are the main ones that need the most attention.
