SIGNALS Documentation
API Reference

First Run

What happens the first time you open a new Signals installation — the setup link, the proof value, the setup wizard steps, and what to do next.

Last reviewed against source:

Install the application

On a new server, clone the repository and run the setup script:

git clone https://github.com/signals-rental/framework-core.git
cd framework-core
composer setup

composer setup finishes by running php artisan signals:install. That command configures PostgreSQL, cache and queues, file storage and websockets, and builds the frontend. It marks the installation as installed only after the frontend build succeeds. The options and each prompt are in Installation.

When it finishes, the command prints two ways to carry on:

Next: Open your browser and visit: {url}/setup?proof={setupProof}
Or continue setup in the terminal: php artisan signals:setup

The first-run pages at /setup are protected by a proof value. signals:install writes it to .env as SIGNALS_SETUP_PROOF, using a random 64-character value unless you already set one, and prints it in the link.

  • Open the printed link, or add ?proof= followed by the value from .env to /setup.
  • Without the correct proof, /setup returns 404. If no proof is configured, it returns 503.
  • Once you have opened the link, your browser session remembers it, so later steps in the wizard do not need the query string.
  • /setup also returns 404 before signals:install has marked the installation as installed, and when a user or a completed setup already exists.
  • Once setup is complete, /setup redirects to the dashboard.

Keep the proof private until setup is done. Anyone who has the link can create the first owner account.

Complete the setup wizard

Before step 1, the wizard checks your database, Redis (when configured) and Reverb credentials. If a check fails, fix the service and choose Retry Checks.

Step Name What you do
1 Company Details Choose the country and enter the company name. Timezone, currency, tax rate and date formats fill in from the country, and you can override them.
2 Warehouses & Locations Add at least one warehouse and mark one as the default.
3 Branding Upload a logo and set the brand colours.
4 Admin Account Enter the name, email address and password of the first owner.
5 Review & Confirm Check the summary, choose Start blank or Load demo data, then choose Complete Setup.

Use Continue and Back to move between steps. Setup then shows Finishing Setup with its progress. If a stage fails, the page shows Setup could not finish and a Retry button. Closing the page does not lose saved progress: the wizard offers a link to resume, and Resume setup asks for the administrator password you chose.

When setup is complete the wizard signs you in as the new owner and opens the dashboard. Field-by-field detail, demo data and recovery from a stalled setup are in Configuration.

To use the terminal instead, run php artisan signals:setup. It asks for the same information.

After setup

  1. Sign in as the owner you created. See Authentication & Settings.
  2. Run the scheduler and queue workers, or background work never happens: see Scheduled Tasks.
  3. Run php artisan signals:status to check database, Redis, storage and Reverb health.
  4. Set up backups before you enter real data: see Backup and Restore.
  5. Add your users, roles and catalogue. Seeders explains what data is already in place.
  6. Read the Limitations and the Glossary so the terms in the interface are familiar.
Reference Use it for
Installation Requirements and the signals:install options
Configuration The wizard fields, the terminal command and recovering a stalled setup
Authentication & Settings Signing in and account settings