Composr Tutorial: Basic configuration and getting started
Written by Chris Graham (ocProducts)Once Composr is installed, there is some basic configuration to do before your website is ready to open.
During basic configuration, you will be familiarising yourself with Composr for the first time. Please be patient: there is a lot to Composr, but once you have a mental image of how things work, you will find it a very powerful and malleable system.
Table of contents
Composr Tutorial: Basic configuration and getting started
- Immediately after installing
- The Setup Wizard
- Editing configuration
- Editing default Comcode pages
- Default banners
- Editing logo theme images
- Editing menus
- Closed site, and opening
- See also
Immediately after installing
- view your website
- run the Admin Zone's Setup Wizard (recommended)
In either case you will be required to log in. Log in using an administration username. If you installed using Conversr (Composr's own forum system), the username and password will have been specified during installation (with the username being 'admin' by default).
If you choose to view your website, you are presented with a screen saying that the site is closed, with a login link. Once logged in, there is a link to the Admin Zone in your 'login block' (alternatively, you can always access your 'Admin Zone' directly by appending /adminzone to your website's URL).
You will see that the Admin Zone keeps reminding you to run the Setup Wizard, so do so when you are ready.
The Setup Wizard
If you run the Setup Wizard, you may wonder later what it actually did, especially if you want to undo it.
The Setup Wizard can perform the following behind-the-scenes functions:
- Generating a "Theme Wizard" theme. You can access the Theme Wizard from Admin Zone > Style > Themes, Theme Wizard link (under Add Theme).
- Generating a "Logo Generator" logo. You can access the Logo Generator separately, from Admin Zone > Style > Logo Wizard.
- Setting site options. You can access these from Admin Zone > Setup > Configuration.
- Removing predefined content. Predefined content can be removed (e.g. default banners). Once this is removed you'd need to put it back manually, by adding it as you would any other content.
- Placing blocks. Blocks are dynamic features embedded directly into your pages/design (other software may use the term 'widgets'). You can place/change blocks via the Zone Editor at Admin Zone > Structure > Block/panel layout (Zone Editor).
- Copying rules. You can edit the rules page manually from Content Management > Pages (Comcode pages).
Important – the Setup Wizard is usually a one-off process
For these reasons, we actually give out a warning if you re-run the Setup Wizard.
NotificationsChances are that you'll want e-mailing whenever things happen on your site. You can do this through your personal notification settings. Go to your profile, choose the Edit tab, and choose the Notifications sub-tab.
In particular you'll probably want to know about content needing validation, various kinds of messaging activity (e.g. support ticket posting), and eCommerce activity.
This is described in more detail in the Notifications tutorial.
If you didn't use the Setup Wizard you will probably have noticed by now that many options are initially set to derivatives of '(Unnamed)'. Don't worry, all these can all be changed as suits your website.
When you visit the full configuration page to fine tune your configuration, you will see that configuration options are split into a number of sections and subsections.
The most important options are in 'Site options', choose that and scroll down your browser window until you find the subsection entitled, 'General'. Once done, scroll to the bottom of the page and click the 'Save' button.
There are many more options in the main configuration, and the actual options available depend on which addons are installed.
Repeat for all other sections you may want to edit.
We don't list all the options in the documentation because they are often either obvious/self-describing, or too specialist to mention – so it's a good idea to browse through to see what interests you.
Editing default Comcode pagesThere are a number of default pages on your site. Standalone editable pages within Composr are called "Comcode pages".
For details on how Comcode pages work and what the default ones are, see the Adding standalone pages of content (via Comcode) tutorial.
Default bannersIf you are not running a community site, you will almost certainly want to delete the default banners. Three banners are added into the system by default, to give websites a 'leg up' and a working view of the banner rotation: but they may not be appropriate. If you ran the Setup Wizard then you have already been given a choice to remove these banners automatically.
Editing logo theme images
When you change images, styling, or low-level HTML structure (defined in templates), you are editing the theme of the site. Therefore to do it, you should go to Admin Zone > Style > Themes.
When you choose to manage images in the default theme, you will be warned against editing the default theme; for this simple task, the warning is irrelevant, and we therefore recommend you click 'ok'. If you are feeling adventurous, you could add a new theme, and continue sculpting your theme as you go.
Choose logo/-logo (the logo for the Welcome Zone, and the logo for any zone that does not have its own) from the drop-down list presented. After clicking the button you will see the current image; all you need to do is create your own replacement on your computer (as a .jpeg/.jpg, .gif or .png file) and choose to browse for it to upload. You do not need to erase the current URL, as your upload will replace it, and you definitely should leave the 'Name' field unchanged.
Your choice of image file formats:
- Use either .png, .jpg, or .gif files:
- .jpg is usually the best choice for a logo, because the file size can be very low. Be aware though that the JPEG format is a 'lossy' format, i.e. the higher the compression, the lower the quality of the image. JPEG does not support transparency.
- .png never loses quality, and also supports transparency – but the sizes are a bit larger.
- .gif is only really a good idea if you need animation, which is unlikely for a logo. Soon will be able to do animation with .png via APNG.
- Do not ever try and use .bmp files with Composr, as they do not have proper compression, and are designed for Windows only.
The menu editor is covered in the Customising what's on the menus tutorial.
SchedulingIn order for aspects of Composr that support scheduling to work it is necessary to set up a system level scheduling task to run the data/cron_bridge.php file on an every-minute basis. By doing this, you tie in the CRON bridge scheduler with the server's scheduler.
Examples of scheduling tasks:
- Sending out calendar event notifications
- Sending out regular notification digest e-mails
- Sending out birthday notifications
- Running automated backups
- Sending automated welcome e-mails to new members
- Sending catalogue view reports and handling classified ad expirations
- Sending out reminders for registration confirmation mails that were not ever actioned by the joining member
- Sending out automatic newsletters
- Sending newsletters (dripping out e-mails over a period of time, to stop resource spiking)
The data/cron_bridge.php file can either be run by passing the PHP file through the PHP interpreter (common), or by calling the URL (see "Help – my webhost does not support CRON!"). More details are in the following sections. Don't call up the URL by hand because if you do then Composr will start assuming the CRON bridge scheduler is working from then on which can make testing it a bit harder (once it is called once it is marked 'working' by the system – applicable features will become available, and the todo item will be removed from the checklist on the front page of the Admin Zone).
Specific advice for Linux
The following command might work for a Composr installation in the /home/examplesite/htdocs directory:
A good test is to try running the command you end up choosing manually in a command prompt, to check it is correct.
You should schedule Composr's cron_bridge.php script to be loaded at least every 10 minutes.
Sandboxes CRONSome webhosts only allow you to execute CRON commands directly under your home directory. This means you cannot call up the PHP command directory like above.
A workaround is to make a data/cron_bridge.sh file (with execute permissions) containing:
Specific advice for WindowsOn Windows the following command might work for a Composr installation in the c:\sites\examplesite\www directory:
The following is a Windows Vista scheduler step by step process for scheduling the running of cron_bridge.php every 5 minutes to enable the scheduler:
- Open up Windows Task scheduler
- Click 'Create Basic Task'
- Give it a name and a description
- Click 'Daily'
- Set the Time and to re-occur every 1 Day
- Click 'Start a Program'
- Under program/script add the location of php.exe on your system something like "C:\php\php.exe" – also include the double Quote Marks ("") surrounding the file location
- Under 'Arguments' add the location to the cron_bridge.php file which for the example above would be "c:\sites\examplesite\www" (note how the PHP command is split across two parameters – step 7 having the php.exe path and step 8 having the PHP file path) – again surround in quote marks.
- Click 'Next'
- Tick (check) "Open the properties dialog for this task when I finish"
- Click 'Finish'
- Click 'Triggers' (top of window)
- Double click the trigger from the list
- Tick (check) 'repeat task every' box
- Change the "1 Hour to 5 Minutes" for the duration of "Indefinitely"
- Click 'OK'
- Click 'OK'
Help – my webhost does not support CRON!In the event your hosting platform does not allow you access to CRON, there are a number of options available to you. These options work to call the data/cron_bridge.php script by URL, rather than via a direct command on the server.
- EasyCron provide direct instructions for Composr, and free and paid plans: https://www.easycron.c…t-up-cron-job-for-composr
- Other free options are http://www.mywebcron.com/ (up to every 5 minutes), http://www.setcronjob.com/ (up to every 5 minutes but the schedule needs to be re-set every week) and http://www.onlinecronjobs.com/ (up to 5 jobs twice a day).
Simply sign up and add the URL i.e. http://yourbaseurl/data/cron_bridge.php to the scheduler and set how often you want it to run.
Closed site, and opening
Admin Zone > Setup > Configuration > Site Options > Closed Site.
It's not advertised in the interface, but it is possible for a user to join a closed Conversr-powered site if they have been given the URL to the join module (they can't see any panels in this event). Once they have joined they can't log in though unless they have subsequently been put in a usergroup with 'Access closed site' permission. The reasoning here is that the staff may give out the join URL and ask someone to use it, and then give special access because they want them to be able to get in early. If you do not like this behaviour, you can alter the join-module's permissions so that the Guest usergroup cannot access it.
- A file used by the Apache web server to set configuration options that apply to the directory (and sub-directories thereof-) that the file is contained in
- Main Admin Zone Configuration
- The 'Configuration' module of the Admin Zone
- Installation Options
- The Installation Options for low-level settings such as database settings, available from config_editor.php
- CRON bridge scheduler
- Composr's scheduler system, tying CRON to Composr's scheduled tasks so that they may be launched
- Basic installation
- Themeing your website
- Advice for choosing and managing staff
- Legal and social responsibilities
- Comcode and the attachment system
- Adding standalone pages of content (via Comcode)
- Customising what's on the menus
- Advanced Configuration
Please rate this tutorial:
Have a suggestion? Report an issue on the tracker.