Installation ​

Installing Spark via Composer ​

To get started installing Spark, add the Spark repository to your application's composer.json file:

"repositories": [
    {
        "type": "composer",
        "url": "https://spark.laravel.com"
    }
],

Next, you may add the laravel/spark-paddle or laravel/spark-stripe package to the list of required packages in your composer.json file:

"require": {
    "php": "^8.2",
    "laravel/framework": "^11.0",
    "laravel/spark-paddle": "^5.0"
},

After your composer.json file has been updated, run the composer update command in your console terminal:

composer update

When running composer update, you will be prompted to provide your login credentials for the Spark website. These credentials will authenticate your Composer session as having permission to download the Spark source code. To avoid manually typing these credentials, you may create a Composer auth.json file and use your API token in place of your password:

{
    "http-basic": {
        "spark.laravel.com": {
            "username": "[email protected]",
            "password": "your-api-token"
        }
    }
}

You may quickly create an auth.json file via your terminal using the following command. As mentioned previously, you may create an API token via the Spark dashboard. This token may be used as a substitute for your password when creating a Composer auth.json file:

composer config http-basic.spark.laravel.com [email protected] your-api-token

Once the package is installed via Composer, run the spark:install Artisan command:

php artisan spark:install

Finally, run the migrate Artisan command:

php artisan migrate

Lastly, you will need to configure Stripe or Paddle webhooks so that these services can communicate with your local application via webhooks. To get started, read our dedicated documentation on Stripe webhooks or Paddle webhooks. Webhooks are required during both local development and in production environments.

That's it! Next, you may navigate to your application's config/spark.php configuration file and begin configuring your Spark installation.

Authenticating Spark in Continuous Integration (CI) Environments ​

It's not advised to store your auth.json file inside your project's version control repository. However, there may be times you wish to download Spark inside a CI environment like Chipper CI. For instance, you may wish to run tests for any custom tools you create. To authenticate Spark in these situations, you can use Composer to set the configuration option inside your CI system's pipeline, injecting environment variables containing the credentials you use to login to the Spark dashboard and a valid Spark dashboard API token:

composer config http-basic.spark.laravel.com ${SPARK_USERNAME} ${SPARK_API_TOKEN}

Expired Licenses ​

If your Spark license has expired and you don't want to renew the license your composer.json file will need to specify the last version of Spark released before your license expired:

"require": {
    "php": "^8.2",
    "laravel/framework": "^11.0",
    "laravel/spark-paddle": "5.y.z"
},