Installation
Next Self-Catering is delivered as a Joomla package: one ZIP that installs the component, eight site modules and nine plugins together. Installing it works like any other Joomla extension.
Before you start
Check the site meets the requirements:
| Requirement | Detail |
|---|---|
| Joomla | 4.4, 5.x or 6.x |
| PHP | 8.1 or higher, with the cURL extension (and GD for the smaller photo copies) |
| Database | MySQL 5.7 or newer, or MariaDB 10.4 or newer |
| HTTPS | Required in production for card payments and payment webhooks |
| Scheduled Tasks | Joomla's task scheduler must be able to run (see below) |
The installer checks the PHP and Joomla versions before it writes anything. On an older version it stops with a message such as "Next Self-Catering requires PHP 8.1.0 or later. This site runs PHP 8.0.30." and nothing is installed. On Joomla 4.4 it installs, then reminds you that Joomla 4 no longer receives security updates.
Use a Super User account for the first setup: staff roles are assigned from inside the component afterwards. See Compatibility for the full list, including the nginx rule for private inspection photos.
Firewall and outgoing connections
Your host's firewall must allow these outgoing HTTPS connections for the features you use. PHP needs the cURL extension.
| From your server to | For |
|---|---|
api.stripe.com |
Stripe payments, refunds, saved cards and holds |
api-m.paypal.com, api-m.sandbox.paypal.com |
PayPal payments and refunds (live, sandbox) |
api.twilio.com |
Twilio text messages |
| Your SMS provider's address | The HTTP SMS gateway |
| The channels' calendar links | iCal sync with Airbnb, Booking.com, Vrbo, Google Calendar and other channels |
| Your webhook addresses | Automation webhooks |
www.ecb.europa.eu |
ECB exchange rates |
| From the visitor's browser to | For |
|---|---|
js.stripe.com |
The Stripe payment form |
www.paypal.com |
The PayPal buttons |
tile.openstreetmap.org |
OpenStreetMap maps |
maps.googleapis.com |
Google Maps, when chosen |
The channels, Stripe and PayPal also call your site: the channels read your calendar export links, and Stripe and PayPal post to each payment method's webhook address. A site behind a password or a firewall must let them through.
Download
Log in at nextsoftware.dev and download the latest package from your account's downloads area. The file is named:
pkg_nextselfcatering_vX.X.X.zip
Keep the ZIP as it is. Do not unzip it before installing.
Install
- Log in to the Joomla administrator.
- Go to System > Install > Extensions.
- Drag
pkg_nextselfcatering_vX.X.X.ziponto the upload area, or click Browse for file and select it. - Wait for the success message. The installer creates the database tables, switches on the package's plugins and adds the scheduled tasks.
The package installs:
| Extension | Type | Role |
|---|---|---|
com_nextselfcatering |
Component | Admin app, public pages, guest, owner and cleaner portals, booking engine |
mod_nextselfcatering_search |
Site module | Search form that opens the Properties list |
mod_nextselfcatering_map |
Site module | Map of the properties, standalone or linked to the Properties list |
mod_nextselfcatering_properties |
Site module | Featured, latest, on offer, recently viewed, similar or hand-picked properties |
mod_nextselfcatering_destinations |
Site module | Location tiles with the number of properties in each |
mod_nextselfcatering_reviews |
Site module | The newest reviews as a slider or grid |
mod_nextselfcatering_calendar |
Site module | A mini availability calendar of one property |
mod_nextselfcatering_wishlist |
Site module | A heart with the number of saved properties |
mod_nextselfcatering_currency |
Site module | Currency picker (shown while the Multi-currency app is on) |
plg_task_nextselfcatering |
Task plugin | The scheduled tasks listed below |
plg_privacy_nextselfcatering |
Privacy plugin | Guest data in Joomla's Privacy export and erasure requests |
plg_finder_nextselfcatering |
Smart Search plugin | Indexes properties for Joomla Smart Search |
plg_user_nextselfcatering |
User plugin | Keeps guest, owner and housekeeper links right when a Joomla account's email changes or the account is deleted |
plg_nextselfcateringpayment_stripe |
Payment plugin | Card and wallet payments through Stripe |
plg_nextselfcateringpayment_paypal |
Payment plugin | PayPal Checkout |
plg_nextselfcateringpayment_banktransfer |
Payment plugin | Bank transfer with your own instructions |
plg_nextselfcateringsms_twilio |
SMS plugin | Text messages through Twilio |
plg_nextselfcateringsms_httpgateway |
SMS plugin | Text messages through any SMS provider with an HTTP API |
Enter your download key
So updates arrive through Joomla's own update channel:
- Go to System > Update > Update Sites.
- Open Next Self-Catering Updates.
- Paste your download key into the Download Key field and save.
New versions then appear under System > Update > Extensions.
Check the scheduled tasks
Many jobs run in the background through Joomla's Scheduled Tasks: expiring holds, sending emails, charging balances, reading channel calendars, running automations and more. The installer creates 14 tasks for you under System > Manage > Scheduled Tasks. They are listed, with what each one does, in Scheduled tasks.
These tasks only run when Joomla's scheduler runs. Either keep the Lazy Scheduler on in System > Manage > Scheduled Tasks > Options (tasks run when people visit the site), or, better on a quiet site, set up a web cron or a server cron that calls Joomla's scheduler every few minutes.
nginx only: protect the private photos folder
Cleaners' inspection photos are stored in media/nextselfcatering-private. Apache and IIS protect
the folder with the .htaccess and web.config the component writes into it. nginx ignores those
files, so add a deny rule for the folder to your server block. See
Compatibility.
Open the component
- Go to Components > Next Self-Catering.
- On a fresh site the Set up your site wizard opens on the dashboard. Follow it, or choose Skip setup and come back to it later from Configure > Settings > Sample data.
See Quick Start for the wizard's steps.
Add the site pages
The public pages are Joomla menu items, so they sit in your site's normal navigation and use your template. Create them under Menus > (your menu) > Add New Menu Item and choose Next Self-Catering as the menu item type:
| Menu item type | What it publishes |
|---|---|
| Properties list | Your properties with the filter, free for the guest's dates when they give them |
| Single Property | One property with its gallery, availability calendar and booking box |
| Availability calendar | Properties down, days across, to pick a free stay |
| My Wishlist | The properties a guest saved |
| Find My Booking | A form that emails a guest their booking link again |
| My Bookings | A logged-in guest's stays and contact details |
| Owner Portal | The logged-in owner's calendar, bookings, blocks, statements, issues and requests |
| Housekeeper Jobs | The logged-in housekeeper's cleaning jobs |
| Manage App | The admin app on a site page, for staff |
Create at least a Properties list item, or a Single Property item if you let one home. Put My Bookings, Owner Portal, Housekeeper Jobs and Manage App in a menu that only registered users see. See Menu items and frontend pages.
The checkout, the guest's booking page and the review page need no menu items of their own: guests reach them from the property page and from the links in their emails.
Then publish the modules you want under Content > Site Modules. To show a map beside the list, put the Map module on the Properties list page with the mode Linked to the Properties list on the page. See Site modules.
Upgrading
Upgrades are installed over the top and keep all your data.
- Back up first. Take a database and files backup before any upgrade.
- Go to System > Update > Extensions, or install the newer
pkg_nextselfcatering_vX.X.X.zipthrough System > Install > Extensions. - Joomla runs any database changes between your version and the new one.
The upgrade also removes the previous version's application files from
media/com_nextselfcatering, so the folder does not grow with every update. After a large upgrade,
reload the admin once with Ctrl+Shift+R so the browser loads the new app.
Uninstalling
Uninstalling deletes your data. The component drops all of its database tables on uninstall: properties, prices, bookings, payments, guests, invoices, statements, everything. Export what you need to keep first.
- Go to System > Manage > Extensions.
- Find Next Self-Catering Package (type: Package), select it and click Uninstall.
Uninstall the package, not the component on its own: the package blocks its parts from being removed separately. Its scheduled tasks are removed with it.
Delete the Next Self-Catering menu items yourself afterwards. Joomla does not remove menu items that pointed at an uninstalled component, and they show errors until you do.
See also
- Quick Start: the setup wizard, step by step
- Settings: every setting, section by section
- Scheduled tasks: the background jobs and the scheduler
- Troubleshooting: if something does not work as expected