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)
|
2021-10-16 14:37:09 +00:00
|
|
|
* [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
|
2021-10-16 14:37:09 +00:00
|
|
|
### lsb_release
|
2021-11-05 15:23:47 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L16)
|
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`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-10-09 15:59:42 +00:00
|
|
|
### sudo_password
|
2021-11-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L157)
|
2021-10-09 15:59:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### ssh_copy_id
|
2021-11-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L163)
|
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-11-05 23:09:55 +01:00
|
|
|
* [provision:configure](/docs/recipe/provision.md#provisionconfigure)
|
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)
|
2021-10-16 14:37:09 +00:00
|
|
|
* [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-11-05 23:09:55 +01:00
|
|
|
* [provision:banner](/docs/recipe/provision.md#provisionbanner)
|
2021-10-09 15:59:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
### provision:check
|
2021-11-05 23:09:55 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L39)
|
2021-10-09 15:59:42 +00:00
|
|
|
|
|
|
|
|
Check pre-required state.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-11-05 23:09:55 +01:00
|
|
|
### provision:configure
|
|
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L58)
|
|
|
|
|
|
|
|
|
|
Collect required params.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-10-11 22:11:11 +02:00
|
|
|
### provision:update
|
2021-11-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L80)
|
2021-10-11 22:11:11 +02:00
|
|
|
|
|
|
|
|
Add repositories and update.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-10-09 15:59:42 +00:00
|
|
|
### provision:upgrade
|
2021-11-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L102)
|
2021-10-09 15:59:42 +00:00
|
|
|
|
|
|
|
|
Upgrade all packages.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-10-11 22:11:11 +02:00
|
|
|
### provision:install
|
2021-11-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L109)
|
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-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L142)
|
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-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L147)
|
2021-10-09 15:59:42 +00:00
|
|
|
|
|
|
|
|
Configure SSH.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### provision:deployer
|
2021-11-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L166)
|
2021-10-09 15:59:42 +00:00
|
|
|
|
|
|
|
|
Setup deployer user.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### provision:firewall
|
2021-11-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L213)
|
2021-10-09 15:59:42 +00:00
|
|
|
|
|
|
|
|
Setup firewall.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-11-05 23:09:55 +01:00
|
|
|
### provision:banner
|
2021-11-06 21:51:01 +01:00
|
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L221)
|
2021-11-05 23:09:55 +01:00
|
|
|
|
|
|
|
|
Show banner.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
