Featured Sites: A-Z Index

H


Newest 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.

Top 10 Entries

Question What are some of the default endpoints available in the server-side API?
Answer Default endpoints cover various functionalities, including:
  • Account: join, login, lost_password, setup_push_notifications
  • Misc: contact_us
  • Content: commandr_fs

Specific details on parameters and response data for each endpoint can be found in the documentation.
Question How does authentication work with the server-side API?
Answer Authentication is handled automatically using cookies, similar to regular website requests. If cookies are not feasible, the response parameters device_auth_member_id_cn/device_auth_pass_hashed_cn/device_auth_member_id_vl/device_auth_pass_hashed_vl from the login endpoint can be resent as POST parameters in subsequent requests.
Question How do I access the server-side API for my mobile app?
Answer The server-side API can be accessed via HTTP calls to http://yourbaseurl/data/endpoint.php. Results are returned in JSON format. The API utilizes endpoints with a 'hook' name and a 'hook type' categorization. Both REST-style and GET-parameter style requests are supported, with the latter recommended for simplicity.
Question What is the purpose of the Composr Mobile SDK Toolkit?
Answer The Toolkit, part of the composr_mobile_sdk addon, aids in mirroring Composr website resources into a mobile app. It includes tools for generating iOS/Android string resources from language files and exporting theme images in a directory structure suitable for iOS/Android app image assets.
Question How can I obtain Composr Mobile SDK?
Answer The iOS/Android SDK can be found on GitLab at: Composr ecosystem / Composr Mobile SDK · GitLab.

To connect to a Composr site, you will need to install the composr_mobile_sdk addon, which is not bundled. This addon provides scripting to generate app assets from the Composr site.
Question What is Composr Mobile SDK?
Answer Composr Mobile SDK (CMS SDK) is a toolkit designed for experienced iOS and Android developers to build mobile apps that integrate with a Composr-powered website. It offers both Composr-specific integrations and a collection of standalone utilities for building apps, providing a common base between iOS and Android akin to the PHP and Composr APIs, enabling easier code porting while maintaining a native experience.
Question What is the Composr maintenance policy?
Answer Composr follows a rolling release model. This means:
  • New major/minor versions are released as they are ready.
  • Patch releases, primarily containing bug fixes, are only released for the latest supported major/minor version branch.
Users are responsible for staying updated to the latest release or applying necessary hotfixes.

This policy allows developers to focus resources on the latest versions and encourages users to leverage the ongoing improvements. You can find the release status on the Composr maintenance status page.
Question What are the general courtesy guidelines for interacting with the Composr community?
Answer
  • Understand that Composr is developed and maintained by volunteers who dedicate their time to the project.
  • Refrain from demanding free support or expecting developers to work on specific schedules.
  • Avoid placing undue pressure on volunteers or pushing them beyond their capacity.
  • Approach the community with respect and a collaborative spirit.
  • Remember that offering financial sponsorship for desired features can accelerate development.
Question How can I provide design feedback for Composr?
Answer Constructive design feedback is valuable. To provide effective feedback:
  • Be specific and detailed. Identify particular issues and provide clear examples.
  • Offer solutions. Suggest improvements or provide mockups demonstrating your ideas.
  • Avoid vague statements. General comments like "it looks dated" are unhelpful.
  • Understand design constraints. Consider factors like modularity, generality, feature density, compatibility, performance, and the subjective nature of design.
Directly reporting specific design bugs to the tracker or redesigning Composr interfaces yourself are excellent ways to contribute.
Question How do I make a feature suggestion for Composr?
Answer You can suggest features through the tracker or the Report Issue Wizard. When making a suggestion:
  • Be comprehensive and self-contained. Provide all necessary information and context for the developers to understand your suggestion.
  • Focus on widely beneficial features. Esoteric suggestions are less likely to be implemented.
  • Understand developer constraints. Feature development depends on factors like developer availability, funding, and project strategy.
  • Consider sponsoring features. Financial contributions can prioritize the development of desired features as it affords developers the time to implement it.