Featured Sites: A-Z Index

H


Newest 10 Entries

Question How do I set the correct file permissions for Composr?
Answer If you're using the quick installer, it will handle file permissions automatically. On a suEXEC-style server, default permissions (744 for directories and 644 for files) are usually sufficient. However, _config.php should have 600 permissions for security.

Without suEXEC, specific directories (e.g., caches, uploads) and files (e.g., _config.php) require 777 (full access) or 666 (read/write) permissions. The fixperms.php script can automate this process on Linux and Windows.
Question How do I install Composr on Linux?
Answer After ensuring your web host meets the requirements and you have a database ready, you can install Composr on Linux using the following steps:
  • Upload the Composr files to your web directory.
  • Navigate to the install.php file in your web browser.
  • Follow the on-screen instructions, providing the required information, such as database details and administrator credentials.
  • After the installation is complete, delete the install.php file for security reasons.
Question What are the prerequisites for installing Composr?
Answer Before installing Composr, ensure your web host meets the minimum requirements. Familiarize yourself with your web host's control panel (e.g., Plesk, cPanel), which you'll use to manage databases, subdomains, and other settings. Gather your SFTP/FTP credentials (hostname, username, password), usually emailed upon signup. Set up a MySQL database and note its details: hostname (often 'localhost'), username, password, and database name. Ensure the database user has full read/write/administer access to the database.
Question What tools are available for debugging Composr code?
Answer Composr offers a code quality checker addon that helps identify various types of errors, including parser errors, run-time errors, and logical errors. This tool can significantly reduce debugging time and enhance code reliability. It is available through the testing_platform addon.
Question What are some key coding standards in Composr?
Answer Composr emphasizes clean, well-structured code with a focus on readability and maintainability. Key standards include proper indentation, consistent use of comments, and clear function headers with type definitions. Remember: beautiful code leads to better functionality and collaboration!
Question Where can I find resources for learning PHP programming?
Answer While Composr documentation doesn't cover basic PHP, resources like the official PHP documentation (

PHP: Hypertext Preprocessor

PHP is a popular general-purpose scripting language that powers everything from your blog to the most popular websites in the world.

View

), online tutorials, and the Composr API guide can help you learn.
Question What is the purpose of the Code Editor?
Answer The Code Editor is a web-based tool for editing Composr code files directly on the server. It requires password authentication and automatically manages overrides within _custom directories.

To access it, go to yourbaseurl/code_editor.php.
Question How can I export and import custom addons?
Answer Composr allows exporting addons as TAR files, containing all necessary files and an addon.inf file for metadata. You can import these addons to share and reuse them across different Composr installations.

To do this, make your necessary files for the addon in the Composr installation, and then go under Admin Zone > Structure > Addons > Export addon. You can select the relevant files for the addon, provide information about the addon, and then download the TAR file (which can then be imported on other Composr sites).
Question Can you give an example of creating a new module?
Answer Imagine creating a "Testing" module to manage collaborative testing:
  • Define purpose: Allow testers to add, assign, and track tests, with security and forum integration.
  • Design database: Plan the necessary database tables and fields to store the module's data.
  • Create module shell: Write the basic module structure based on standard Composr modules.
  • Define screens: Identify the module's screens and code their corresponding functions.
  • Utilize API functions: Use Composr's built-in API functions like create_table, add_privilege, and do_template to implement functionality.
Question What are the different ways to extend Composr functionality?
Answer You can extend Composr through:
  • File overrides: Replacing existing source files with modified versions in _custom directories.
  • New Modules/Mini-modules: Creating new modules for complex functionalities or mini-modules for simpler ones.
  • New Blocks/Miniblocks: Adding reusable content blocks.
  • New API code: Adding new PHP files to the sources_custom directory.
  • Hooks: Writing hooks to add features to specific areas of functionality.

Top 10 Entries

Question What is rate limiting and how can I enable it in Composr?
Answer Rate limiting prevents server overload by restricting the number of requests allowed from a single IP address within a specific timeframe. To enable Composr's built-in rate limiting, add the following to your _config.php file:

Code (PHP)

$SITE_INFO['rate_limiting'] = '1';
$SITE_INFO['rate_limit_time_window'] = '10';
$SITE_INFO['rate_limit_hits_per_window'] = '5';
 

This configuration limits each IP to 5 requests every 10 seconds. This feature generates soft errors early in the process before Composr fully loads.
Question How can I reduce disk activity to improve performance?
Answer If your hard disk is slow, you can implement the following settings in your _config.php file to minimize disk access:
  • $SITE_INFO['disable_smart_decaching'] = '1';
  • $SITE_INFO['no_disk_sanity_checks'] = '1';
  • $SITE_INFO['hardcode_common_module_zones'] = '1';
  • $SITE_INFO['prefer_direct_code_call'] = '1';
  • $SITE_INFO['charset'] = 'utf-8';
  • $SITE_INFO['known_suexec'] = '1';
  • $SITE_INFO['dev_mode'] = '0';
  • $SITE_INFO['no_extra_logs'] = '1';
  • $SITE_INFO['no_extra_bots'] = '1';
  • $SITE_INFO['no_extra_closed_file'] = '1';
  • $SITE_INFO['no_installer_checks'] = '1';
  • $SITE_INFO['assume_full_mobile_support'] = '1';
  • $SITE_INFO['no_extra_mobiles'] = '1';

Note: These settings override default behaviors and may have unintended consequences. Use with caution.
Question What is static caching and how do I enable it?
Answer Static caching drastically improves performance by serving pre-generated pages to bots and guests. This works because these users typically don't require dynamic content. To enable it:
  • Go to the Installation Options editor (yourbaseurl/config_editor.php). You will need your maintenance password.
  • Activate the static cache option.

Composr intelligently determines what to cache, and you can further control this via options within the Installation Options. Be aware that enabling static caching may disable eCommerce features for guests unless specifically configured.
Question What are Composr caches and how do they improve website performance?
Answer Composr utilizes various types of caches to enhance performance by storing pre-calculated results and reducing repetitive tasks. These caches include:
  • Language cache: Eliminates the need to parse language files on each page load.
  • Template cache: Avoids reparsing template files repeatedly.
  • Comcode page cache & Comcode cache: Reduces the need to parse Comcode pages and general Comcode usage.
  • Block cache: Caches blocks based on their parameters, minimizing execution.
  • Theme image cache: Prevents redundant searches for theme images.
  • Values caches: Stores calculated values like member post counts.
  • Persistent cache: Keeps frequently used data in memory for faster access.
  • Advanced admin cache: Allows admins to view cached pages while the server generates updates.
  • Static cache: Serves static pages to bots and guests, bypassing much of the framework.
  • Self learning cache: Optimizes resource loading by learning which resources each page requires.
Question How can I troubleshoot notification problems?
Answer If you're having issues with notifications, here are some troubleshooting steps:
  • Check Email Logs: View the email log (Admin Zone > Audit > E-mail queue/log) to see what notifications have been sent.
  • Use the SU Feature: Impersonate a member using the SU feature (described in the "Testing access and privileges" tutorial) to view their notification settings and confirm they are set up correctly.
  • Enable Carbon-copy Email: Configure a "Carbon-copy e-mail address" in the configuration settings to receive copies of all outgoing emails, including notifications. This helps you monitor email delivery.
  • Verify System Scheduler: Ensure the system scheduler is configured correctly if members are not receiving digest emails.
  • Check Digest Settings: Confirm that "Enable digest notifications" is enabled in the Messages configuration settings.
  • Review "Safety listing limit": If a notification has too many categories, members might not see the full selection tree. Adjust the "Safety listing limit" in the configuration settings if necessary.
Question Can I control which notifications members receive?
Answer Yes, you can control notification settings through two mechanisms:
  • Notification Defaults: You can set default notification preferences for all members. You can enable or disable specific notifications and choose the delivery method (Admin Zone > Setup > Notification defaults).
  • Notification Lock-down: You can force members to receive or prevent them from receiving certain notifications (Admin Zone > Setup > Notification lock-down). This allows you to enforce specific notification policies and manage email volume.
Question What notification options are available to members?
Answer Members can choose from a wide range of notifications, including:
  • Content Updates: Notifications for new or updated content, such as news articles, forum posts, and gallery images.
  • Private Messages: Alerts for new private messages received.
  • Friend Requests: Notifications for new friend requests.
  • Administrative Actions: Alerts for actions taken by site administrators, such as account approvals or content moderation decisions.

Members can choose to receive notifications via:
  • Email: Notifications sent directly to their email address.
  • Digest Email: Combined summaries of activity sent in batched emails. This requires the system scheduler and the digest e-mails configuration option to be enabled.
  • Private Topics: Notifications delivered as private forum topics.
  • SMS: Notifications sent as text messages (requires configuration and incurs costs).
  • Web Notifications: Real-time alerts displayed within the Composr interface.
Question Can I share content like news and banners across the M.S.N.?
Answer Yes, you can share news by placing it on the central site and using RSS blocks on satellite sites to display it. Banners can be shared by adding them to the central site and configuring satellite sites to use the central site's banner.php script.
Question What should I consider when managing usergroups for subcommunities?
Answer
  • Rank ladders: Use the default rank ladder for main site ranks and secondary usergroups for subcommunity memberships.
  • New member status: Set default usergroups for new members to grant them initial access while allowing removal if necessary.
  • Leadership: Assign leaders to usergroups to allow members to manage subcommunities.
  • Clubs: Consider using Clubs for member-driven subcommunities with their own forums.
Question What are Composr Clubs and how are they useful for subcommunities?
Answer Clubs are special usergroups in Conversr (Composr's forum system) designed for creating subcommunities. They come with their own dedicated forums and are managed by members, taking pressure off site staff.

Key features:
  • No special permissions by default, simplifying permission management.
  • Members can join and leave like regular usergroups.
  • Provide a dedicated forum for the club.