Documentation Install and integrate

Install ClientStack

Use the guided installer on a fresh server and create the first account and team.

The installer creates the administrator, first account, and first team.
The installer creates the administrator, first account, and first team.

Product screen with sample data. Intake is the previous working name.

Before you start

Use a fresh, empty database for a new installation. Obtain the release package and its release notes from NowSquare. Confirm the server requirements.

A development checkout with sample logins is not a production release. Do not seed demo users into a live installation.

Prepare the server

  1. Upload the release package to the application directory.
  2. Create an empty MySQL database.
  3. Create a database user with the required access.
  4. Set the web document root to the application’s public/ directory.
  5. Enable HTTPS for the chosen domain.
  6. Give the web process write access to storage and bootstrap/cache.
  7. Open the HTTPS address.

A fresh installation opens /install.

Follow the installer

  1. Resolve every failed requirements check.
  2. Enter the database connection details.
  3. Run the database test.
  4. Enter the product name, URL, locale, and time zone.
  5. Enter the SMTP details.
  6. Send a test email.
  7. Enter and test the TypeSafe API key.
  8. Complete the license step if the package uses a license service.
  9. Enter your administrator details.
  10. Enter the first account and team names.
  11. Review the summary.
  12. Select Finish.

Keep passwords and API keys private. The installer does not show saved secrets in full.

Check the first sign-in

Finish creates the database structure and the initial access grants. This first-install process gives the administrator account-owner and first-team-owner access.

  1. Sign in.
  2. Open the first team.
  3. Confirm the product name.
  4. Create a sample request type.
  5. Test a request with sample text.

The installer returns 404 after completion. This prevents a second installation over the existing one.

Enable scheduled work

Copy the cron instruction that Finish shows into your server’s scheduler. A typical Laravel schedule runs once per minute:

* * * * * cd /path/to/clientstack && php artisan schedule:run >> /dev/null 2>&1

Replace the example path and use the correct PHP executable. Check the health screen to confirm that the scheduler ran.

Check the AI connection

The installer can let you skip a failed service test. Skipping does not make live judging work. Set and test the TypeSafe connection before accepting real applicant requests.

Continue with updates and health.

Find an answer

Try “publish”, “API”, or “human handoff”.