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 Are there any limitations to importing forum data?
Answer Yes, some limitations exist, particularly with specific forum platforms.
  • General: Private messages are often combined into private topics.
  • phpBB: Usergroup configuration and HTML entities may require manual adjustments after import.
  • vBulletin: Calendar recurrences, ratings (karma), and 'goes to coventry' are not imported perfectly. Attachments may need to be extracted directly from the live database due to potential corruption in SQL dumps.
  • Simple Machine Forum: Banning features may not import perfectly due to differences in how Composr handles bans.
Question Where can I find the import functionality in Composr?
Answer Navigate to Admin Zone > Tools > Import.
Question What data formats can Composr import?
Answer Composr primarily uses database connections for importing. However, it also supports neutral data formats like CSV spreadsheet files and importing downloads from a directory.
Question Can I import data from other platforms into Composr?
Answer Yes, Composr offers importers for several popular platforms:
  • Forum Software: Invision Board, MyBB, phpBB, Simple Machine Forum, vBulletin
  • Content Management Systems: WordPress
  • Special Importers: HTML website importer, Composr merge (for merging another Composr site)
Question How do I move my Composr website to a new server?
Answer Moving a Composr site involves transferring both the files and the database.

Files:
  • On the old server, ZIP the entire Composr directory.
  • Download the ZIP file to your computer.
  • Upload the ZIP file to the new server using SFTP/FTP.
  • On the new server, unzip the file.

Database:
  • On the old server, create an SQL dump of your database using the mysqldump command or phpMyAdmin.
  • Download the SQL dump file.
  • If your URL is changing, search and replace the old URL with the new one in the SQL dump file.
  • Upload the SQL dump file to the new server.
  • Restore the database on the new server using the mysql command or phpMyAdmin.

Important Steps:
  • File Permissions: After transferring files, ensure correct file permissions are set on the new server. You can use the fixperms.php script, the upgrader script, or manually adjust them.
  • Configuration: If database settings are different on the new server, update the _config.php file or use the config_editor.php script to change the settings for both the site and forum databases.
  • Base URL: If your URL has changed, update the base URL setting in the Installation Options editor (config_editor.php).
  • Caches: Clear the block cache using the upgrader.php script.
Question Can I integrate third-party JavaScript libraries into Composr?
Answer Yes, you can integrate third-party JavaScript libraries using various methods:
  • Direct reference by URL: Include the library's URL in your theme's HTML.
  • Composr's JavaScript API: Use Composr's API for organized inclusion and potential future compatibility benefits.
  • Manual integration: Directly include the library's code in appropriate template files.
Choose the method best suited for your needs and technical proficiency.
Question How does Composr handle user authentication with external systems like LDAP or HTTP authentication?
Answer Composr can integrate with LDAP and HTTP authentication, but these features are considered complex and may require programming experience to set up correctly. Both methods allow users to log in to Composr using their existing credentials from the external system, streamlining access and management.
Question What are the limitations of using a third-party forum driver?
Answer Using a third-party forum driver can lead to limitations. Custom profile fields of type LONG_TEXT are limited to TEXT length, cookie integration is not officially supported and can be complex, and some forum drivers have specific quirks detailed in the nuances tutorial.
Question What are the implications of using the "none-forum" driver?
Answer Using the "none-forum" driver disables or limits many Composr features, including commenting, points, and user interactions. Consider using Conversr instead and restricting access to the forum zone, join module, and personal zone.
Question How can I integrate my forum visually into my website?
Answer Composr allows you to integrate your forum visually into your website. Enable "Show forum within website" in the Admin Zone configuration module and update the forum link in your menu to pass through the "forums" embedding module. You may need to adjust CSS to achieve a seamless look.