deployphp/deployer

View on GitHub
docs/recipe/deploy/writable.md

Summary

Maintainability
Test Coverage
<!-- DO NOT EDIT THIS FILE! -->
<!-- Instead edit recipe/deploy/writable.php -->
<!-- Then run bin/docgen -->

# Writable Recipe

```php
require 'recipe/deploy/writable.php';
```

[Source](/recipe/deploy/writable.php)


## Configuration
### http_user
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/writable.php#L8)


:::info Autogenerated
The value of this configuration is autogenerated on access.
:::




### http_group
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/writable.php#L25)

Used to make a writable directory by a server.
Used in `chgrp` mode of [writable_mode](/docs/recipe/deploy/writable.md#writable_mode) only.
Attempts automatically to detect http user in process list.
:::info Autogenerated
The value of this configuration is autogenerated on access.
:::




### writable_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/writable.php#L40)

List of writable dirs.



### writable_mode
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/writable.php#L49)

One of:
- chown
- chgrp
- chmod
- acl
- sticky
- skip

```php title="Default value"
'acl'
```


### writable_use_sudo
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/writable.php#L52)

Using sudo in writable commands?

```php title="Default value"
false
```


### writable_recursive
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/writable.php#L55)

Use recursive mode (-R)?

```php title="Default value"
false
```


### writable_chmod_mode
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/writable.php#L58)

The chmod mode.

```php title="Default value"
'0755'
```



## Tasks

### deploy:writable
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/writable.php#L61)

Makes writable dirs.