deployer/docs/recipe/provision.md

134 lines
2.9 KiB
Markdown
Raw Normal View History

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
2021-11-05 15:23:47 +01:00
* [databases](/docs/recipe/provision/databases.md)
* [nodejs](/docs/recipe/provision/nodejs.md)
2021-10-09 15:59:42 +00:00
* [php](/docs/recipe/provision/php.md)
* [website](/docs/recipe/provision/website.md)
## Configuration
### lsb_release
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L16)
Name of lsb_release like: focal, bionic, etc.
As only Ubuntu 20.04 LTS is supported for provision should be the `focal`.
2021-10-09 15:59:42 +00:00
### sudo_password
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L133)
2021-10-09 15:59:42 +00:00
### ssh_copy_id
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L143)
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
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L21)
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)
2021-10-11 22:11:11 +02:00
* [provision:update](/docs/recipe/provision.md#provisionupdate)
2021-10-09 15:59:42 +00:00
* [provision:upgrade](/docs/recipe/provision.md#provisionupgrade)
2021-10-11 22:11:11 +02:00
* [provision:install](/docs/recipe/provision.md#provisioninstall)
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)
2021-10-11 22:11:11 +02:00
* [provision:server](/docs/recipe/provision.md#provisionserver)
2021-10-09 15:59:42 +00:00
* [provision:php](/docs/recipe/provision/php.md#provisionphp)
* [provision:composer](/docs/recipe/provision/php.md#provisioncomposer)
* [provision:npm](/docs/recipe/provision/nodejs.md#provisionnpm)
2021-10-11 22:11:11 +02:00
* [provision:website](/docs/recipe/provision/website.md#provisionwebsite)
2021-10-09 15:59:42 +00:00
### provision:check
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L37)
2021-10-09 15:59:42 +00:00
Check pre-required state.
2021-10-11 22:11:11 +02:00
### provision:update
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L56)
2021-10-11 22:11:11 +02:00
Add repositories and update.
2021-10-09 15:59:42 +00:00
### provision:upgrade
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L78)
2021-10-09 15:59:42 +00:00
Upgrade all packages.
2021-10-11 22:11:11 +02:00
### provision:install
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L85)
2021-10-09 15:59:42 +00:00
2021-10-11 22:11:11 +02:00
Install packages.
2021-10-09 15:59:42 +00:00
2021-10-11 22:11:11 +02:00
### provision:server
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L118)
2021-10-09 15:59:42 +00:00
2021-10-11 22:11:11 +02:00
Configure server.
2021-10-09 15:59:42 +00:00
### provision:ssh
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L123)
2021-10-09 15:59:42 +00:00
Configure SSH.
### provision:deployer
2021-11-05 15:23:47 +01:00
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L146)
2021-10-09 15:59:42 +00:00
Setup deployer user.
### provision:firewall
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L193)
2021-10-09 15:59:42 +00:00
Setup firewall.