mirror of
https://github.com/deployphp/deployer.git
synced 2025-02-24 01:02:24 +01:00
151 lines
3.4 KiB
Markdown
151 lines
3.4 KiB
Markdown
<!-- DO NOT EDIT THIS FILE! -->
|
|
<!-- Instead edit recipe/provision.php -->
|
|
<!-- Then run bin/docgen -->
|
|
|
|
# Provision Recipe
|
|
|
|
[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#L216)
|
|
|
|
|
|
|
|
|
|
|
|
### ssh_copy_id
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L222)
|
|
|
|
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#L59)
|
|
|
|
Collects required params.
|
|
|
|
|
|
|
|
|
|
### provision:update
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L82)
|
|
|
|
Adds repositories and update.
|
|
|
|
|
|
|
|
|
|
### provision:upgrade
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L104)
|
|
|
|
Upgrades all packages.
|
|
|
|
|
|
|
|
|
|
### provision:install
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L111)
|
|
|
|
Installs packages.
|
|
|
|
|
|
|
|
|
|
### provision:server
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L145)
|
|
|
|
Configures a server.
|
|
|
|
|
|
|
|
|
|
### provision:ssh
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L206)
|
|
|
|
Configures the ssh.
|
|
|
|
|
|
|
|
|
|
### provision:deployer
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L225)
|
|
|
|
Setups a deployer user.
|
|
|
|
|
|
|
|
|
|
### provision:firewall
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L272)
|
|
|
|
Setups a firewall.
|
|
|
|
|
|
|
|
|
|
### provision:verify
|
|
[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L280)
|
|
|
|
Verifies what provision was successful.
|
|
|
|
|
|
|
|
|