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 Where are download galleries located, and can I move them?
Answer By default, download galleries (to contain screenshots of a download) are placed under the root gallery. You can move them to a different gallery for better organization. Here's how:

  • Create a new container gallery (e.g., with codename "downloads").
  • Change the "Create download galleries under" configuration option to your new gallery's codename.
  • Use Commandr to move existing galleries to the new location.
Question Can I sell downloads on my Composr site?
Answer Yes, the download system integrates with the points system, allowing you to charge for downloads. This is particularly useful for communities where members create and share content, like game modifications. You can set prices for downloads and creators earn points when users purchase them. Additionally, you can create a subscription-based system by requiring points for downloads, which users can purchase via methods like PayPal.
Question What does it mean to "outmode" a download?
Answer Outmoding means marking a download as superseded or replaced by a newer version. When editing the older download, you link it to the new one in the "outmode" field. This makes it clear to users that there is a newer version available. This is handy especially if you provide software.
Question What are the different ways to add downloads to my Composr site?
Answer Composr offers several methods for adding files to the download system:

  • Uploading via web form (when adding a download in the Content Management Zone): This is the simplest method, where you attach the file directly when defining the download details. However, it's not suitable for large files and can be affected by unreliable internet connections.
  • Uploading and referencing the URL: You can manually upload the file using FTP/SFTP/SCP and then provide the URL to the file in the 'Add download' form. While this is better for large files, it requires additional
 access, and the file isn't managed directly by Composr.
  • Batch adding from an FTP server: This allows staff to add multiple downloads from an FTP server in one go using FTP URLs. It's efficient for bulk uploads but requires separate addition of descriptions.
  • Batch adding from a directory: Similar to the FTP method, staff can add downloads from a web server directory accessible by URL.
  • File/media library (filedump): Webmasters can use any of the above methods to upload a file to uploads/filedump and then reference it in a download. This is especially handy if you are going to reference the file more than once on your site.
Question What is the Composr Setup Wizard and what does it do?
Answer The Setup Wizard is a guided process to help you configure essential settings for your Composr website after installation.

It can:
  • Generate a default theme and logo
  • Set initial site options
  • Remove predefined content and unnecessary addons
  • Place initial blocks on your pages

While convenient, be aware that re-running the Setup Wizard may overwrite existing settings and customizations if you already configured your site.
Question How can I change the structure of my Composr website's pages?
Answer You can delete and move pages using the Admin Zone > Structure > Sitemap editor. However, moving pages between zones might invalidate existing page-links unless specified using the _SEARCH zone in the link.

To avoid issues with existing links and search engine indexing, consider setting up redirects when moving pages. This can be done through Admin Zone > Structure > Redirects.

It is recommended not to move default Composr pages as it can complicate future upgrades.
Question What are Installation Options and how can I change them?
Answer Installation Options are low-level settings for Composr, such as database details and default language.

You can access the Installation Options editor through:

  • The script: http://yourbaseurl/config_editor.php
  • The Admin Zone: Admin Zone > Setup > Configuration > Installation Options

Remember that you'll need your maintenance password, specified during installation, to access and modify these options.
Question How do I open or close my Composr website to the public?
Answer By default, your Composr site is closed after installation. To open it to the public (or to close an opened site), go to Admin Zone > Setup > Configuration > Site options > Closed site and adjust the setting accordingly. You can also configure a closed site message.

While a closed site prevents public access, it's worth noting that users can still join a closed Conversr-powered site if they have access to the join module URL. However, they won't be able to log in unless they're assigned to a usergroup with "Access closed site" permissions. You can modify the join module's permissions to restrict access further.
Question What is the .htaccess file and how does it relate to Composr?
Answer The .htaccess file is a configuration file for the Apache web server. It allows you to define settings that apply to the directory where it's located and its subdirectories.

Composr can leverage .htaccess to enhance security and enable features like "URL Schemes." You can try renaming the provided recommended.htaccess file to .htaccess. This file includes recommended options that tighten security and ensure Composr has necessary PHP and Apache features activated.

Note that some web hosts might restrict the use of .htaccess files.

You should regularly review recommended.htaccess for changes between Composr updates.
Question How do Composr permissions work?
Answer Composr employs a multi-layered permission system with two main types: privileges and access permissions. The system grants users the best possible access based on the combination of their usergroups.

Privileges define broad permissions, such as accessing a closed site or content manipulation abilities based on impact level (low, medium, high). You can set privileges for usergroups via checkboxes, with the option to override them for specific pages or categories. Go to Admin Zone > Security > Global privileges.

Access permissions control what content users can view. These permissions are layered:

  • Zone access permissions
  • Page (or content entry) access permissions
  • Catalogue access permissions
  • Category access permissions

To configure access permissions, you can edit the specific resource or utilize the Permissions Tree Editor under Admin Zone > Security > Permissions Tree Editor.