Installation

Install Desk in your browser

Use File Manager to unlock setup and choose your own local owner.

Platform
PHP web application
PHP
8.2 or newer
MySQL / MariaDB
Dedicated database
Technology
JavaScript
Technology
CSS

Before opening setup

Prepare the required host and empty database. Keep the database name, username, password and hostname available privately. Hosting systems may add an account prefix to the database and username; enter their complete names.

Unlock the installer

  1. Upload and extract the Desk release into its new directory, including hidden files.
  2. Open /install/ on your Desk HTTPS domain.
  3. In hosting File Manager, open storage/setup/setup-key.txt inside the Desk installation.
  4. Paste that private key into the setup form. Do not put it in the URL or share it.

The key expires after one hour. Unlocking consumes it and allows only that browser to finish for twenty minutes. If you lose that browser, wait for the window to expire, reload setup and read the newly generated key.

Create the installation

Enter the canonical HTTPS URL, empty database details, company name, timezone and chosen owner name, email and password. The owner password must be 12–72 bytes. Setup generates a fresh application key, creates the schema and bundled modules, and creates only your chosen owner. It refuses existing configuration and nonempty databases.

On success, setup locks and redirects to local sign-in at /admin/master/login.php. There is no default account or shared password. SMTP and external AI start disabled.

Optional terminal preflight

From the application directory, as its PHP user, you can run:

php tools/install.php --check

Normal browser setup does not require a terminal or hand-edited JSON. Advanced CLI installation is documented in the release README.

Next, configure routing and forms and test email.

← All Desk guidesGet help →

Need help with Desk?

Tell us the product version and what you are trying to do. Keep passwords and private keys out of your message.

Contact Emaila