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 What is the Composr Repository?
Answer The Composr repository is a user-friendly representation of Composr's data, which is typically stored in a database and on the filesystem. It presents the data in an easily accessible format using the JSON standard and can be accessed as a folder on your computer via WebDAV.
Question What is Commandr?
Answer Commandr is a command-line interface designed for experienced system administrators who prefer using a command line over a GUI. It supplements the Composr Admin Zone, allowing you to execute commands in the form of:
  • PHP code (prefix :)
  • SQL database queries (prefix @) (queries must be executed one at a time; semi-colon separation is not supported)
  • Shell commands (prefix #)
  • Commandr-code scripts (store in the Composr filesystem's bin directory, and just type the name of the script)
  • Commandr-code commands (no prefixes)

You can access Commandr via the Admin Zone > Tools > Commandr or using the Commandr button in the footer.
Question Are there alternative chat solutions that integrate with Composr?
Answer Yes, you can integrate third-party chat solutions with Composr. For example, CometChat is a commercial chat system that provides a Composr integration. You can also leverage video chat services like Talky, Jitsi, or appear.in by embedding links within your chat templates. For sales-chat needs, consider integrating a dedicated live chat platform like Comm100.
Question Are there any limitations to the Composr Chat system?
Answer While the Composr Chat system provides robust chat and IM features, it does have some limitations. Currently, it does not support video chat, sales-focused chat features, desktop app integration, or optimal performance for very high volumes of concurrent users. Additionally, it is only near real-time as Composr queries for new messages using AJAX at a set interval.
Question Are there any safety guidelines for younger users?
Answer It's crucial to emphasize safety, especially for younger users. Encourage them to follow these guidelines: never arrange to meet anyone from a chatroom in person, be cautious about sharing personal information, and report any suspicious behavior to moderators.
Question Can I download chat logs?
Answer Yes, you can download logs of any chat conversation. Simply navigate to the chatroom, click on the "Download chat logs" link, specify the desired date/time range, and the system will generate a downloadable log file for you.
Question How can I moderate the chatrooms?
Answer Composr offers a range of moderation features. Moderators can edit or delete messages, ban disruptive users, and delete entire chatrooms if necessary. Inline moderation links are available within chatrooms for quick actions, while the Admin Zone provides comprehensive moderation tools for managing chat content and user behavior.
Question What is Chatcode and how can I use it?
Answer Chatcode is a system of simple commands that you can embed within your chat messages to perform advanced actions. These actions include sending private messages to specific users within a chatroom, interacting with automated bots, sending chatroom invitations, and even creating new chatrooms.
Question How does the chat system work?
Answer The chat system utilizes AJAX technology, enabling dynamic updates without requiring page reloads. It includes a "Chat Lobby" where users can view available chatrooms and manage their friend lists for instant messaging. Users can join chatrooms to participate in group conversations or engage in private conversations with friends.
Question What is the Composr Chat system?
Answer Composr Chat is a feature built into the Composr CMS that provides both chatrooms and instant messaging capabilities. It offers real-time, text-based communication for users on your website.