deployer/docs/recipe/provision.md

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

# provision

[Source](/recipe/provision.php)

* Requires
  * [databases](/docs/recipe/provision/databases.md)
  * [nodejs](/docs/recipe/provision/nodejs.md)
  * [php](/docs/recipe/provision/php.md)
  * [website](/docs/recipe/provision/website.md)

## Configuration
### lsb_release
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L15)

Name of lsb_release like: focal, bionic, etc.
As only Ubuntu 20.04 LTS is supported for provision should be the `focal`.


### sudo_password
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L215)


### ssh_copy_id
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L221)

Specify which key to copy to server.
Set to `false` to disable copy of key.

```php title="Default value"
'~/.ssh/id_rsa.pub'
```


## Tasks

### provision
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L20)

Provision the server.


This task is group task which contains next tasks:
* [provision:check](/docs/recipe/provision.md#provisioncheck)
* [provision:configure](/docs/recipe/provision.md#provisionconfigure)
* [provision:update](/docs/recipe/provision.md#provisionupdate)
* [provision:upgrade](/docs/recipe/provision.md#provisionupgrade)
* [provision:install](/docs/recipe/provision.md#provisioninstall)
* [provision:ssh](/docs/recipe/provision.md#provisionssh)
* [provision:firewall](/docs/recipe/provision.md#provisionfirewall)
* [provision:deployer](/docs/recipe/provision.md#provisiondeployer)
* [provision:server](/docs/recipe/provision.md#provisionserver)
* [provision:php](/docs/recipe/provision/php.md#provisionphp)
* [provision:databases](/docs/recipe/provision/databases.md#provisiondatabases)
* [provision:composer](/docs/recipe/provision/php.md#provisioncomposer)
* [provision:npm](/docs/recipe/provision/nodejs.md#provisionnpm)
* [provision:website](/docs/recipe/provision/website.md#provisionwebsite)
* [provision:verify](/docs/recipe/provision.md#provisionverify)


### provision:check
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L39)

Checks pre-required state.


### provision:configure
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L58)

Collects required params.


### provision:update
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L81)

Adds repositories and update.


### provision:upgrade
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L103)

Upgrades all packages.


### provision:install
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L110)

Installs packages.


### provision:server
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L144)

Configures a server.


### provision:ssh
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L205)

Configures the ssh.


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

Setups a deployer user.


### provision:firewall
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L271)

Setups a firewall.


### provision:verify
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L279)

Verifies what provision was successful.
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00			`<!-- DO NOT EDIT THIS FILE! -->`
			`<!-- Instead edit recipe/provision.php -->`
			`<!-- Then run bin/docgen -->`

			`# provision`

			`[Source](/recipe/provision.php)`

			`* Requires`
Include databases.php 2021-11-05 15:23:47 +01:00			`* [databases](/docs/recipe/provision/databases.md)`
[automatic] Update docs with bin/docgen 2021-10-16 14:37:09 +00:00			`* [nodejs](/docs/recipe/provision/nodejs.md)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00			`* [php](/docs/recipe/provision/php.md)`
			`* [website](/docs/recipe/provision/website.md)`

			`## Configuration`
[automatic] Update docs with bin/docgen 2021-10-16 14:37:09 +00:00			`### lsb_release`
Add fetch() func 2021-11-07 10:49:16 +01:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L15)`
[automatic] Update docs with bin/docgen 2021-10-16 14:37:09 +00:00
			`Name of lsb_release like: focal, bionic, etc.`
			As only Ubuntu 20.04 LTS is supported for provision should be the `focal`.



Update docs with bin/docgen 2021-10-09 15:59:42 +00:00			`### sudo_password`
[automatic] Update docs with bin/docgen 2021-11-22 21:51:48 +00:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L215)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00




			`### ssh_copy_id`
[automatic] Update docs with bin/docgen 2021-11-22 21:51:48 +00:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L221)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
			`Specify which key to copy to server.`
			Set to `false` to disable copy of key.

			```php title="Default value"
			`'~/.ssh/id_rsa.pub'`
			```



			`## Tasks`

			`### provision`
Add fetch() func 2021-11-07 10:49:16 +01:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L20)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
			`Provision the server.`




			`This task is group task which contains next tasks:`
			`* [provision:check](/docs/recipe/provision.md#provisioncheck)`
Improve provision recipe 2021-11-05 23:09:55 +01:00			`* [provision:configure](/docs/recipe/provision.md#provisionconfigure)`
Refactor provision recipe 2021-10-11 22:11:11 +02:00			`* [provision:update](/docs/recipe/provision.md#provisionupdate)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00			`* [provision:upgrade](/docs/recipe/provision.md#provisionupgrade)`
Refactor provision recipe 2021-10-11 22:11:11 +02:00			`* [provision:install](/docs/recipe/provision.md#provisioninstall)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00			`* [provision:ssh](/docs/recipe/provision.md#provisionssh)`
			`* [provision:firewall](/docs/recipe/provision.md#provisionfirewall)`
			`* [provision:deployer](/docs/recipe/provision.md#provisiondeployer)`
Refactor provision recipe 2021-10-11 22:11:11 +02:00			`* [provision:server](/docs/recipe/provision.md#provisionserver)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00			`* [provision:php](/docs/recipe/provision/php.md#provisionphp)`
Add missing provisioning of databases in provision recipe (#2768) * Add missing provisioning of databases in provision recipe In addition, increase timeout of `mysql-server` install * Updated docs 2021-11-21 11:52:32 +01:00			`* [provision:databases](/docs/recipe/provision/databases.md#provisiondatabases)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00			`* [provision:composer](/docs/recipe/provision/php.md#provisioncomposer)`
[automatic] Update docs with bin/docgen 2021-10-16 14:37:09 +00:00			`* [provision:npm](/docs/recipe/provision/nodejs.md#provisionnpm)`
Refactor provision recipe 2021-10-11 22:11:11 +02:00			`* [provision:website](/docs/recipe/provision/website.md#provisionwebsite)`
Add fetch() func 2021-11-07 10:49:16 +01:00			`* [provision:verify](/docs/recipe/provision.md#provisionverify)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00

			`### provision:check`
Add missing provisioning of databases in provision recipe (#2768) * Add missing provisioning of databases in provision recipe In addition, increase timeout of `mysql-server` install * Updated docs 2021-11-21 11:52:32 +01:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L39)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
Add *s 2021-11-08 22:59:39 +01:00			`Checks pre-required state.`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00



Improve provision recipe 2021-11-05 23:09:55 +01:00			`### provision:configure`
Add missing provisioning of databases in provision recipe (#2768) * Add missing provisioning of databases in provision recipe In addition, increase timeout of `mysql-server` install * Updated docs 2021-11-21 11:52:32 +01:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L58)`
Improve provision recipe 2021-11-05 23:09:55 +01:00
Add *s 2021-11-08 22:59:39 +01:00			`Collects required params.`
Improve provision recipe 2021-11-05 23:09:55 +01:00



Refactor provision recipe 2021-10-11 22:11:11 +02:00			`### provision:update`
Add missing provisioning of databases in provision recipe (#2768) * Add missing provisioning of databases in provision recipe In addition, increase timeout of `mysql-server` install * Updated docs 2021-11-21 11:52:32 +01:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L81)`
Refactor provision recipe 2021-10-11 22:11:11 +02:00
Add *s 2021-11-08 22:59:39 +01:00			`Adds repositories and update.`
Refactor provision recipe 2021-10-11 22:11:11 +02:00



Update docs with bin/docgen 2021-10-09 15:59:42 +00:00			`### provision:upgrade`
Add missing provisioning of databases in provision recipe (#2768) * Add missing provisioning of databases in provision recipe In addition, increase timeout of `mysql-server` install * Updated docs 2021-11-21 11:52:32 +01:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L103)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
Add *s 2021-11-08 22:59:39 +01:00			`Upgrades all packages.`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00



Refactor provision recipe 2021-10-11 22:11:11 +02:00			`### provision:install`
Add missing provisioning of databases in provision recipe (#2768) * Add missing provisioning of databases in provision recipe In addition, increase timeout of `mysql-server` install * Updated docs 2021-11-21 11:52:32 +01:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L110)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
Add *s 2021-11-08 22:59:39 +01:00			`Installs packages.`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00



Refactor provision recipe 2021-10-11 22:11:11 +02:00			`### provision:server`
[automatic] Update docs with bin/docgen 2021-11-22 21:51:48 +00:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L144)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
Add *s 2021-11-08 22:59:39 +01:00			`Configures a server.`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00



			`### provision:ssh`
[automatic] Update docs with bin/docgen 2021-11-22 21:51:48 +00:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L205)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
Add *s 2021-11-08 22:59:39 +01:00			`Configures the ssh.`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00



			`### provision:deployer`
[automatic] Update docs with bin/docgen 2021-11-22 21:51:48 +00:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L224)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
Add *s 2021-11-08 22:59:39 +01:00			`Setups a deployer user.`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00



			`### provision:firewall`
[automatic] Update docs with bin/docgen 2021-11-22 21:51:48 +00:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L271)`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
Add *s 2021-11-08 22:59:39 +01:00			`Setups a firewall.`
Update docs with bin/docgen 2021-10-09 15:59:42 +00:00



Add fetch() func 2021-11-07 10:49:16 +01:00			`### provision:verify`
[automatic] Update docs with bin/docgen 2021-11-22 21:51:48 +00:00			`[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L279)`
Add fetch() func 2021-11-07 10:49:16 +01:00
Add *s 2021-11-08 22:59:39 +01:00			`Verifies what provision was successful.`
Add fetch() func 2021-11-07 10:49:16 +01:00