Brightpail - Cleaning Business Manager
A complete website and back office for house-cleaning businesses: online booking, quotes, a staff area, a mobile-friendly job app for cleaners with before-and-after photos, online payments, hiring, and an easy website editor.
What's included
- Public website with a home page slider, services and prices, service areas, about, contact form, newsletter sign-up, careers, privacy policy and terms. Nine themes (Midnight, Breeze, Sunrise, Evergreen, Citrus, Slate, Blossom, Splash and Confetti), each with its own colours, fonts and artwork, and phone layouts.
- Online booking by date and arrival window, with add-ons, photos of the home, and an optional deposit. Customers can ask for a repeat cleaning every week, every 2 weeks or every 4 weeks. Choose who can book online: everyone, only existing clients, or nobody (everyone else gets a "Get a free quote" form).
- Quote requests with photos, handled through a simple pipeline (New → Contacted → Quote sent → Booked).
- Staff area: today's schedule, bookings, customers, messages, reports with PDF and CSV export, and settings.
- Cleaner app: assigned jobs on any phone, before and after photos (at least three "after" photos to finish a job), reporting problems, and office review before a job counts as complete.
- Payments through Stripe: pay after the cleaning by emailed link, optional deposits, plus cash and check recorded by staff.
- Hiring: job openings, applications, and turning a hire into a staff account.
- Privacy built in: photos stripped of location data and deleted after a set time, closed accounts anonymized, quote requests and applications purged automatically.
- Roles and permissions: Admin, Office Staff and Cleaner to start with, and your own roles.
- Easy hosting: a web installer, works on ordinary shared hosting (no command line or queue worker needed), and one-click updates.
Server requirements
Most shared hosting plans (cPanel, Plesk, DirectAdmin) and any VPS work. The installer checks everything for you.
| Needed | Details |
|---|---|
| PHP 8.3 or newer | With the extensions bcmath, ctype, curl, dom, fileinfo, filter, mbstring, openssl, pdo, tokenizer, xml, and GD or Imagick. Recommended: intl (prices and dates in your language), imagick (iPhone HEIC photos), zip. |
| A database | MySQL 8+, MariaDB 10.6+, PostgreSQL 13+, or SQLite (fine for trying it out). |
| A cron job | Every minute. Most control panels have a "Cron Jobs" page. |
| Uploads of 10 MB+ | upload_max_filesize and post_max_size of at least 10M for phone photos, 30M if you want slider videos. |
| HTTPS | Strongly recommended (free certificates are included with most hosting). |
Installation
Allow about 15 minutes. You don't need the command line.
1. Upload the files
- Unzip the download. Inside the
sourcefolder is the site. - Upload everything inside
sourceto your hosting, for example to a folder calledcleaningnext topublic_html, with your control panel's File Manager or an FTP program. Include hidden files such as.env.exampleand.htaccess. - Point your domain (or subdomain) at the
publicfolder inside it. In cPanel: Domains → Manage → Document Root, set tocleaning/public.
public_html). The included .htaccess sends every visit into public/ and keeps everything else unreachable. This needs Apache with mod_rewrite (standard on shared hosting). On nginx, set the root to public/.2. Create a database
In your control panel (e.g. cPanel → MySQL Databases), create a database and a user, give the user All privileges on the database, and note the database name, username and password. Many hosts add a prefix such as account_ to both.
3. Run the installer
- Open your site in a browser. You'll see Welcome! Let's set up your site. Anything marked with a red cross needs fixing first; your host can help (it's usually a PHP version or extension setting in the control panel).
- Enter the database details. Host is usually
localhost. The installer checks the connection before saving. - Enter your business name, email, website address, timezone and currency, and create your admin login. Leave Add example services and home page content ticked for a starter price list and home page to edit.
- Optional: tick Add sample customers, bookings and staff to try things out to fill the site with made-up customers, cleaners, bookings, repeat cleanings, quotes, messages and job applications, so you can see every screen working. Nobody can sign in as these people, and their
example.comaddresses can't receive email. While it's there, a notice at the top of the staff area has a Remove sample data button (admins only): use it before you go live. It deletes only the sample, plus any bookings you made for sample customers. - Click Install. You're signed in as the admin and shown the cron job to add.
The installer writes your settings to the .env file and then locks itself.
4. Add the cron job
Add this in your control panel's Cron Jobs page, to run every minute (replace the path with your site's folder, shown on the last installer page):
* * * * * cd /home/account/cleaning && php artisan schedule:run >> /dev/null 2>&1
It books the next visits of repeat cleanings, sends emails in the background, deletes old photos and personal details on time, and cleans up unused files. If php isn't PHP 8.3 on your host, use the full path your host's help pages give (e.g. /usr/local/bin/php8.3). Until the cron job runs, emails are sent straight away instead, so nothing is lost. Business settings → Email shows whether it's running.
Development & staging copies
The steps above set up your live site, the one customers use. If you (or a developer) plan to change themes or code, or want to try a new version before your customers see it, keep a second copy for that. Never try out changes on the live site.
A copy on your computer (development)
For editing themes, text or code. You need PHP 8.3+, Composer and Node.js 20+, or an all-in-one tool such as Laravel Herd (Mac and Windows), which includes PHP and Composer.
- Unzip the download and open a terminal in the
sourcefolder. - Copy
.env.exampleto.env. It's already set for development (APP_ENV=local,APP_DEBUG=true, and emails written tostorage/logs/laravel.loginstead of being sent). For the simplest database, changeDB_CONNECTION=mysqltoDB_CONNECTION=sqlite, delete the otherDB_lines, and create an empty file calleddatabase/database.sqlite. - Run these commands:
composer install php artisan key:generate php artisan migrate --seed php artisan storage:link npm install npm run devcomposer installadds the developer tools (the download only includes what a live site needs).npm run devkeeps running and reloads styles as you edit them. - In a second terminal, run
php artisan serveand openhttp://127.0.0.1:8000(with Herd, use the address it gives you instead).
On a development copy, migrate --seed skips the installer and adds sample data with ready-made logins, all with the password password: admin@example.com (admin), staff@example.com (office staff), test@example.com (customer) and the cleaners maria@example.com, james@example.com, aisha@example.com, daniel@example.com, sofia@example.com and marcus@example.com. These logins only exist when APP_ENV=local; a live or staging site never gets them. To start over with fresh sample data, run php artisan migrate:fresh --seed (this erases that copy's database).
pk_test_ and sk_test_), leave email on log, and don't copy your live database onto your computer: it holds your customers' personal details.A staging site (a test copy online)
For trying a new version or your changes on a real server before the live site, or for showing them to someone. Set it up on its own address, such as staging.yourdomain.com, with its own database:
- Follow Installation as for the live site, with the staging address as the website address. On the business details step, tick Add sample customers, bookings and staff so there's something to try things on (remove it whenever you like with the button at the top of the staff area).
- Use Stripe's test keys and, if you connect email, a mailbox you own, so no customer ever gets a test email.
- Keep the public out: password-protect the site in your hosting control panel (often called Directory privacy or Password protect), so search engines and customers can't find it.
Don't copy your live database to staging unless it's protected as well as the live site, for the same privacy reasons.
Moving changes to the live site
- Try the change on your development or staging copy first.
- If you changed styles or scripts, run
npm run buildand include thepublic/buildfolder. - Back up the live site, then upload only the files you changed (or a new version, as in Updating). Never upload your development
.envordatabasefile: the live site keeps its own. - If the update screen appears, click Update now.
First steps
After installing, the staff Overview shows a Getting started list (for admins) with these steps. Most tick themselves as you set things up; tick the others with I've done this, or hide the list. Every staff page also has a folded How this page works note at the top, and cleaners see a short guide on My jobs the first time they sign in.
- Email: connect your email account and send yourself a test email (see Email).
- Business details: phone, address, areas you serve, logo, homepage photo, and the home page highlights.
- Services: your prices. Services without a type are add-ons.
- Booking rules and Region & language.
- Payments: add your Stripe keys if you want online payments.
- Legal pages: the Privacy Policy and Terms are starting drafts. Have them checked by a lawyer for where you work.
- Users: add your team and give them roles. Turn on two-factor authentication for staff (Settings → Security).
Business settings
Everything below is under Business settings in the staff area. Pages with passwords or keys (Email, Stripe keys, File storage) are for admins only by default. Saved passwords and keys are encrypted and never shown again; leave a field empty to keep the saved value. Each page shows where its settings come from (Saved here, From the server's .env file, or Not set up), and you can remove saved details at any time: Remove keys on Payments turns online payments off, Remove saved account on Email goes back to the .env settings, and on File storage an S3 or Google Drive account can be removed once no files are stored there.
The site sends booking confirmations, payment links, password resets, and alerts for your team.
| Option | Use it for |
|---|---|
| An email account (SMTP) | Most providers. Common settings: Your hosting email: server mail.yourdomain.com, port 465 (SSL) or 587 (TLS), your full email address and its password.Google Workspace / Gmail: smtp.gmail.com, 587 TLS, your address, and an app password (Google account → Security → App passwords; needs 2-step verification).Microsoft 365: smtp.office365.com, 587 TLS (SMTP sending must be allowed for the mailbox).Brevo, SendGrid, Amazon SES, Postmark: use the SMTP details from their dashboard. |
| Mailgun | Your verified sending domain and API key; choose EU if your Mailgun account is in the EU region. |
| This server (sendmail) | No setup, but emails often land in spam. |
| Don't send (write to the log) | Trying the site out: emails are written to storage/logs. |
Use a From address on your own domain, set up with your email provider (SPF and DKIM records), so emails don't land in spam.
When emails go out: Automatic (recommended) sends in the background while the cron job runs and straight away when it doesn't. A queue worker is only for servers that run php artisan queue:work all the time (e.g. with Supervisor).
Payments (Stripe)
- Create a free account at stripe.com.
- In the Stripe Dashboard, open Developers → API keys and copy the publishable key (
pk_…) and the secret key (sk_…). - Open Developers → Webhooks → Add endpoint. Use the address shown on the Payments page (
https://yourdomain.com/stripe/webhook) and the eventcheckout.session.completed. Copy its signing secret (whsec_…). - Paste all three on Business settings → Payments and save. Try a payment in test mode (keys starting
pk_test_andsk_test_, card 4242 4242 4242 4242), then switch to your live keys.
Customers pay after their cleaning is approved, through a secure Stripe page linked in an email. You can also ask for a deposit when they book (a percentage or a fixed amount), and staff can record cash and check payments. Payments are taken in the currency set under Region & language.
File storage
Website pictures and slider videos are public; photos of customers' homes are private and only open for people allowed to see them. All pictures are resized and have their location data removed.
- This web server (default): nothing to set up.
- S3-compatible storage: Amazon S3, DigitalOcean Spaces, Cloudflare R2, Wasabi, Backblaze B2 and others. Enter the access key, secret key, bucket and region (and the endpoint for anything but Amazon). Public files go in the bucket's
public/folder: make that folder readable by visitors (a bucket policy, or the provider's public URL / CDN) and enter its web address. Private photos stay inprivate/and open through links that work for a few minutes. - Google Drive (private photos only): create a service account in Google Cloud, enable the Drive API, add the service account's email as a member of a Shared Drive, and paste its JSON key and the folder ID.
Saving checks the storage works first. Files saved earlier keep working where they are; Move them now copies them across.
Booking rules
The arrival windows customers choose from (up to six, e.g. Morning 8–12), the days you're closed, how far ahead people can book, and how many hours before a cleaning they can still cancel online. Staff can always book any date and time, and set exact times on bookings.
Repeat cleanings: choose which repeats customers can pick when they book (every week, every 2 weeks, every 4 weeks), or none. See Repeat cleanings.
Who can book online is on the Overview and on Business details: everyone, existing clients only (people with a completed cleaning, or approved on their customer page), or paused. Everyone who can't book sees the quote form instead.
Region & language
Timezone, language, currency, date style (Oct 7, 2026 · 7 Oct 2026 · 2026-10-07), 12- or 24-hour times, and how long booking photos, quote requests, job applications and closed accounts are kept. The Privacy Policy shows these numbers automatically. Changing the currency does not convert your prices.
Website & themes
- Business details: name, contact details, areas served, logo and pictures, the main headline, the highlights under it, and social links.
- Home page slider: the main slide plus up to six more (text, photo or video backgrounds, buttons, start and end dates, phone options). Preview each slide on a computer and a phone before saving.
- Website content: banners and "why choose us" features.
- Legal pages: edit the Privacy Policy and Terms. Placeholders such as
{company_name}and{photo_retention_days}fill themselves in. - Themes: choose one for the website (including sign-in pages, customer accounts and emails) and one for the staff area. Preview shows a theme only to you.
Team, roles & permissions
Add people under Users; they get an email to set their password. A role is a set of permissions: Admin can do everything; Office Staff handles bookings, customers, messages and payments; Cleaner sees their own jobs. Create your own roles under Roles & permissions, or give one person extra permissions. Customers have no role.
Running your business
- Bookings: new online bookings arrive as Pending; confirm them, assign cleaners, reschedule, or cancel. Staff can book for customers any time (Bookings → New booking), including from a quote request.
- Repeat cleanings: a repeat books the same cleaning every 1, 2 or 4 weeks, on the same day and time. When a customer asks for one online, their first visit arrives as Pending like any booking; once you confirm it, the next visits are booked automatically, about 8 weeks ahead, by the cron job. Staff can make any new booking repeat (Bookings → New booking), and those visits are booked straight away. Each visit is an ordinary booking with its own cleaners, photos and payment; visits use the current prices, keep the cleaners from the latest visit, and skip days you're closed. Customers can cancel a single visit (the rest stay booked) or stop repeating. On any visit's page, staff can change how often, the day and the time, pause, resume or stop the repeat; visits you moved by hand are kept, and the next visit's cleaner stays on the repeat (also through a pause and resume) (confirm the first visit of a customer's request before changing it). Cleaners get one email listing any of their jobs that come off the schedule. Bookings → Repeat cleanings lists every repeat with its next visit, and flags any that have nothing booked (for example because their cleaning service was switched off) or whose first visit passed without being confirmed. Repeats also show on the customer's page and in the cleaner's job app.
- Jobs: cleaners see their jobs under My jobs, upload before and after photos, and mark the job done. The office reviews it and either approves it (the customer is emailed a payment link) or sends it back.
- Quotes and messages: work through requests from the website; book a cleaning straight from a quote.
- Reports: revenue and bookings for any period, as PDF or CSV.
Updating
- Back up your database and the
storagefolder. - Upload the new
sourcefiles over the old ones. Keep your.envfile andstoragefolder (don't delete them first). - Open your site. You'll see Finish the update; click Update now. Your content, bookings and settings are kept.
If you've changed files in resources/ or app/, keep a copy of your changes: uploading the new version replaces them. Use a custom theme folder (see Customizing) so your changes are easy to carry over.
Translating
The site is in English and ready for translation. To add a language (here Spanish, es), run on the server or your computer:
php artisan translations:export es
This creates lang/es.json with every phrase on the site, each still in English. Translate the values (not the keys), keeping words that start with a colon, such as :name, as they are. Then choose the language under Region & language. Running the command again after an update adds new phrases and keeps your translations.
Customizing (developers)
Built with Laravel 13, Livewire 4, Flux UI (free) and Tailwind CSS 4. Main folders:
app/Actions | Business logic (one class per action). |
resources/views/pages | Pages (Livewire single-file components). |
resources/views/themes/{key} | Theme pieces: hero art and backdrop, eyebrow, brand. Missing pieces fall back to the default theme. |
resources/css/themes/{key}.css | Theme colours and fonts, as --theme-* variables. |
config/themes.php | The list of themes: name, fonts, images, colours shown in the picker, theme wording. |
config/*.php | Defaults, e.g. booking.php, photos.php, media.php. Admin settings override them. |
Adding a theme
- Copy
resources/css/themes/breeze.csstoresources/css/themes/mytheme.css, change[data-theme='breeze']to[data-theme='mytheme']and the colours, and import it inresources/css/app.css. - Add an entry to
config/themes.php(keys are lowercase and never change). Add any new fonts tovite.config.js. - Optionally copy
resources/views/themes/breezetoresources/views/themes/mythemeand change the art. - Rebuild the styles:
npm installthennpm run build(needs Node.js 20+), and uploadpublic/build.
Keep text colours at a contrast of at least 4.5:1 against their backgrounds (WCAG AA), so everyone can read them; the themes that come with the site all do. A free checker such as WebAIM's contrast checker shows the ratio for any two colours.
Useful commands
php artisan users:make-admin you@example.com | Make an existing account an admin (e.g. if you're locked out). |
php artisan media:move | Copy files to the storage now in use. |
php artisan optimize | Speed up a live site (run again after changing files). |
php artisan optimize:clear | Clear all cached files. |
Demo mode
For running a public demo only (never for a real business). Set DEMO_MODE=true in .env and run php artisan demo:reset. The login page then offers one-click logins as Admin, Office staff, Cleaner and Customer, a bar lets visitors switch themes, emails only go to the log, account and setup changes and uploads are locked, and everything is wiped and refilled with demo data every night (the cron job must be running).
Troubleshooting
"500 Server Error" or a blank page
Make sure storage and bootstrap/cache (and everything in them) are writable by the web server (permissions 755 for folders, 644 for files, owned by your account on shared hosting). The reason is written to storage/logs/laravel.log. To see it on screen briefly, set APP_DEBUG=true in .env, and set it back to false afterwards.
The page has no styling, or shows "public" in the address
The domain isn't pointing at the public folder. See Upload the files. Also check APP_URL in .env matches your address, including https://.
"400 Bad Request" after moving to a new domain
For security, the site only answers to the domain in APP_URL (and its subdomains, such as www.). This stops anyone tricking it into emailing password-reset links that point to another website. After moving to a new domain, set APP_URL in .env to the new address, e.g. APP_URL=https://newdomain.com.
Emails don't arrive
Send a test email from Business settings → Email; any error is shown there. Check spam folders, use a From address on your own domain, and ask your email provider for the correct SMTP settings. Some hosts block outgoing ports 465/587; ask them to open them or use Mailgun.
Pictures don't show
Nothing to do in most cases: if the host can't create the public/storage link, the site sends pictures itself. If you moved the site, run php artisan storage:link (or delete public/storage and let the site serve pictures).
"The file is too large" when uploading
Raise upload_max_filesize and post_max_size in your control panel's PHP settings (e.g. MultiPHP INI Editor in cPanel).
Online payments don't mark bookings as paid
Check the Stripe webhook address and that it listens for checkout.session.completed, and that the signing secret on the Payments page is the one for that webhook (test and live mode have different ones).
I forgot the admin password
Use Forgot your password? on the login page (email must work), or run php artisan users:make-admin you@example.com for another account you can sign in to.
Running the installer again
Delete storage/app/installed.json (the database is not touched; use a new, empty database for a fresh start).
Security checklist
- Run the installer straight after uploading, and use HTTPS.
- Keep
APP_DEBUG=falseon a live site. - Turn on two-factor authentication for every staff account.
- Back up the database and the
storagefolder regularly (most hosts can do this automatically). - Only give the Admin role and the "Email, payment & storage setup" permission to people who need them.
- Install updates when they come out.
Credits & licenses
Brightpail - Cleaning Business Manager is sold under the license you bought it with. It's built on open-source software, listed with their licenses in THIRD-PARTY-NOTICES.md in the download, including Laravel (MIT), Livewire and Flux UI (free edition), Tailwind CSS (MIT), Stripe PHP (MIT), Intervention Image (MIT), DomPDF (LGPL), the AWS SDK and Google API client (Apache 2.0), and spatie/laravel-permission (MIT). Fonts (Instrument Sans, Plus Jakarta Sans, DM Sans, DM Serif Display, Fraunces, Nunito, Space Grotesk, Playfair Display, Fredoka, Baloo 2, Figtree, Inter and Karla) are under the SIL Open Font License; their copyright notices and the license are in licenses/fonts/. Theme illustrations are original artwork included with this product. Icons are Heroicons (MIT).
Support
Questions and problems: email gqplaisted@gmail.com, Please include the order number or license key from your purchase, your version and build (v1.1.0, build 6fe4ecf; also in BUILD.txt in your site's folder), what you tried, and the last lines of storage/logs/laravel.log if there was an error. Customization work is not included in support.