deployer/docs/recipe/provision.md
2021-11-05 14:09:11 +00:00

133 lines
2.9 KiB
Markdown

<!-- DO NOT EDIT THIS FILE! -->
<!-- Instead edit recipe/provision.php -->
<!-- Then run bin/docgen -->
# provision
[Source](/recipe/provision.php)
* Requires
* [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#L132)
### ssh_copy_id
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L142)
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: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:composer](/docs/recipe/provision/php.md#provisioncomposer)
* [provision:npm](/docs/recipe/provision/nodejs.md#provisionnpm)
* [provision:website](/docs/recipe/provision/website.md#provisionwebsite)
### provision:check
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L36)
Check pre-required state.
### provision:update
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L55)
Add repositories and update.
### provision:upgrade
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L77)
Upgrade all packages.
### provision:install
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L84)
Install packages.
### provision:server
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L117)
Configure server.
### provision:ssh
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L122)
Configure SSH.
### provision:deployer
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L145)
Setup deployer user.
### provision:firewall
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L189)
Setup firewall.