deployer/docs/recipe/laravel.md

<!-- DO NOT EDIT THIS FILE! -->
<!-- Instead edit recipe/laravel.php -->
<!-- Then run bin/docgen -->

# laravel

[Source](/recipe/laravel.php)



* Requires
  * [common](/docs/recipe/common.md)

## Configuration
### shared_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L8)

Overrides [shared_dirs](/docs/recipe/common.md#shared_dirs) from `recipe/common.php`.



```php title="Default value"
['storage']
```


### shared_files
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L9)

Overrides [shared_files](/docs/recipe/common.md#shared_files) from `recipe/common.php`.



```php title="Default value"
['.env']
```


### writable_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L10)

Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`.



```php title="Default value"
[
    'bootstrap/cache',
    'storage',
    'storage/app',
    'storage/app/public',
    'storage/framework',
    'storage/framework/cache',
    'storage/framework/sessions',
    'storage/framework/views',
    'storage/logs',
]
```


### log_files
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L21)



```php title="Default value"
'storage/logs/*.log'
```


### laravel_version
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L22)






## Tasks

### artisan:down
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L93)

Put the application into maintenance / demo mode.




### artisan:up
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L96)

Bring the application out of maintenance mode.




### artisan:&#8203;key:generate
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L103)

Set the application key.




### artisan:passport:keys
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L106)

Create the encryption keys for API authentication.




### artisan:db:seed
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L113)

Seed the database with records.




### artisan:migrate
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L116)

Run the database migrations.




### artisan:migrate:fresh
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L119)

Drop all tables and re-run all migrations.




### artisan:migrate:rollback
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L122)

Rollback the last database migration.




### artisan:migrate:status
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L125)

Show the status of each migration.




### artisan:cache:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L132)

Flush the application cache.




### artisan:config:cache
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L135)

Create a cache file for faster configuration loading.




### artisan:config:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L138)

Remove the configuration cache file.




### artisan:event:cache
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L141)

Discover and cache the application\'s events and listeners.




### artisan:event:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L144)

Clear all cached events and listeners.




### artisan:event:list
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L147)

List the application\'s events and listeners.




### artisan:optimize
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L150)

Cache the framework bootstrap files.




### artisan:optimize:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L153)

Remove the cached bootstrap files.




### artisan:route:cache
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L156)

Create a route cache file for faster route registration.




### artisan:route:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L159)

Remove the route cache file.




### artisan:route:list
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L162)

List all registered routes.




### artisan:storage:link
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L165)

Create the symbolic links configured for the application.




### artisan:view:cache
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L168)

Compile all of the application\'s Blade templates.




### artisan:view:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L171)

Clear all compiled view files.




### artisan:queue:failed
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L178)

List all of the failed queue jobs.




### artisan:queue:flush
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L181)

Flush all of the failed queue jobs.




### artisan:queue:restart
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L184)

Restart queue worker daemons after their current job.




### artisan:horizon
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L187)

Start a master supervisor in the foreground.




### artisan:horizon:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L190)

Delete all of the jobs from the specified queue.




### artisan:horizon:continue
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L193)

Instruct the master supervisor to continue processing jobs.




### artisan:horizon:list
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L196)

List all of the deployed machines.




### artisan:horizon:pause
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L199)

Pause the master supervisor.




### artisan:horizon:purge
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L202)

Terminate any rogue Horizon processes.




### artisan:horizon:status
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L205)

Get the current status of Horizon.




### artisan:horizon:terminate
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L208)

Terminate the master supervisor so it can be restarted.




### artisan:&#8203;telescope:clear
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L215)

Clear all entries from Telescope.




### artisan:&#8203;telescope:prune
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L218)

Prune stale entries from the Telescope database.




### deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/laravel.php#L224)

Deploy your project.

Main deploy task.


This task is group task which contains next tasks:
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [artisan:storage:link](/docs/recipe/laravel.md#artisanstoragelink)
* [artisan:view:cache](/docs/recipe/laravel.md#artisanviewcache)
* [artisan:config:cache](/docs/recipe/laravel.md#artisanconfigcache)
* [deploy:publish](/docs/recipe/common.md#deploypublish)