Quick start

This article gives the short version of installing Tidemark Billing. The linked articles cover each route in detail.

Pick a route#

Check Requirements first if you are unsure whether your host qualifies.

Shared hosting in five steps#

1. Download the release zip (tidemark-billing-x.y.z.zip). Dependencies are bundled.
2. Upload and unzip it on your host. Point the domain's document root at the public/ folder.
3. Open https://your-domain/install. The page checks the server, connects your database, runs the migrations and creates your admin account.
4. Add a cron job that runs php artisan schedule:run every minute, or use the web cron URL from Settings → System.
5. Under Settings → Email, add your SMTP details. Then turn on a payment plugin under Plugins and fill in its keys under Settings → Payments.

Docker in two steps#

1. Run docker compose up -d with the project's docker-compose.yml.
2. Open http://localhost:8080/install and create your admin account.

The Docker image runs the scheduler and a queue worker for you, so there is no cron job to add.

After installing#

Open Settings in the admin menu and work through General, Billing and Email. Then add a product. The installer closes itself once it has run: visiting /install afterwards redirects to the home page.

Related#

• Requirements
• Set up the cron job
• Email