Featured Sites: A-Z Index

H


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

Top 10 Entries

Question How do I restore my Composr website from a backup?
Answer Composr backups come as .tar or .tar.gz files. Extract the archive using an extraction program like 7-zip or your web hosting control panel.

To restore a full backup:
  • Upload the extracted files to your webserver, overwriting the existing files.
  • Run the included restore.php script in your browser. This script will restore the database from the restore_data.php file.

To restore incremental backups:
  • Restore the initial full backup.
  • Sequentially extract and overwrite files from each incremental backup over the restored full backup.
  • The last extracted restore_data.php will contain the latest database state. Run restore.php to restore the final database version.
Question What alternative backup strategies are available?
Answer Many web hosting control panels include built-in backup features that operate at the system level, often offering higher reliability than web-based scripts. Ensure you back up both files and the database.

For database backups, you can use tools like phpMyAdmin, which allows you to export your database as a .sql file.
Question How do I create a backup of my Composr website?
Answer Composr offers a built-in backup addon accessible from Admin Zone > Tools > Backups. You can choose between full, incremental, and database-only backups.
  • Full backup: Backs up all files and folders within the Composr installation directory, including the database.
  • Incremental backup: Backs up only new or changed files since the last backup, resulting in smaller backup files.
  • Database backup only: Backs up only the database.

The addon allows scheduled backups or manual backup generation. It is recommended to download backups to a location outside your web server for better security.

Note: The Composr backup addon is limited by server-side PHP capabilities and might not always be reliable. Consider using alternative backup strategies offered by your web hosting control panel for increased reliability.
Question Why are backups necessary for my Composr website?
Answer Disasters like hard disk failures, data corruption, and unexpected errors can happen at any time. A good backup strategy helps you recover your website and its data in case of such events. Backups can also help you roll back to a previous state if needed, such as after a failed upgrade or accidental changes.
Question How can I control the privacy of member profile fields?
Answer You can control the privacy of member profile fields through the "Member privacy controls" configuration option.

If you enable the "Extended privacy option control", you can fine-tune visibility settings for each field. Otherwise, you can set simple access levels (e.g., not at all, to members, to friends, to everyone) for each field.
Question What is the difference between a Composr member and an author?
Answer A member is someone who has created an account on your Composr website and can log in. They have a unique member ID and username, and can interact with the site's features.

An author is someone who creates content for the site. They may or may not be a member. For example, you might have an author who submits articles via email but never actually visits or joins the website.
Question What advanced techniques are available for dealing with persistent spammers who repeatedly create new accounts?
Answer Composr's advanced banning features target sophisticated human spammers. Automatic bans can be configured to block users based on specific strings in their posts, while reasoned bans display customized messages to banned users, potentially deterring them. These measures, coupled with the ability to investigate users via IP address analysis, offer robust tools for managing persistent threats.

You can configure advanced banning under Admin Zone > Security > Configure advanced banning.
Question How does Composr handle user banning and what options are available?
Answer Composr offers various banning mechanisms. You can ban members by editing their accounts (ban member tick box), preventing logins while still allowing guest access. IP address banning blocks access from specific IP addresses or ranges (Admin Zone > Security > Members > Investigate user to see their IP addresses and flag certain ones for banning). You can also restrict member submissions, or you can effectively "suspend" users by assigning them to a usergroup with minimal privileges (e.g. probation).
Question What is the "Warn Member" form and how can I use it to handle rule violations?
Answer The "Warn Member" form provides a centralized interface for addressing user misconduct. You can issue formal or off-the-book warnings, apply punitive actions like IP bans, usergroup changes, or probation, and even delete content or charge points. This form allows you to document reasons for actions, improving transparency and consistency in moderation.

This tool can be accessed on a member's profile as staff, under Audit > Warn member. You can also review their warnings history on their "Standing" tab.
Question How does Composr track user activity?
Answer Composr logs IP addresses for various actions like guest posting, page views, and content submissions. This data helps identify potential spammers and track user behavior. The "Investigate user" module provides tools to analyze IP addresses and gather additional information about suspicious activity.