https://github.com/bolt/simple-deploy
https://github.com/bolt/simple-deploy
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/bolt/simple-deploy
- Owner: bolt
- Created: 2017-08-14T16:12:29.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-09T14:54:41.000Z (over 6 years ago)
- Last Synced: 2025-04-24T11:41:49.774Z (about 2 months ago)
- Language: PHP
- Size: 38.1 KB
- Stars: 8
- Watchers: 14
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Bolt Simple Deploy Tool
=======================
To use this tool, on your development machine **only** you can create a file
named `.deploy.yml`.
Each key in the `.deploy.yml` represents a deployment target that can be
uploaded to via either FTP or SFTP (secure FTP).
Every deployment configuration you add to `.deploy.yml` must set the `protocol`
to either `ftp` or `sftp`, and an `options` array.
**NOTE:** If your host provides SFTP, it is the preferred upload method as it
is both faster and more secure than FTP alone, and supports more functionality.
Command Usage
-------------
```
php app/nut setup:deploy [options]
```
### Arguments
| Value | Description |
| ------ | ----------- |
| target | Name of the deployment setting to use from .deploy.yml
### Options
| Value | Description |
| ------ | ----------- |
| --check | Only check the connection settings for a given deployment
| --edit | Interactively create or edit a deployment configuration
### Example: Editing or creating a connection
```
php app/nut setup:deploy --edit production
```
### Example: Checking a connection
```
php app/nut setup:deploy --check production
```
### Example: Running a deployment
```
php app/nut setup:deploy production
```
Configuration File
------------------
Configuration is done in a `.deploy.yml` file in the site's root directory on
your development environment, with the following format:
```
staging:
protocol:
options:
host:
root:
username:
…
```
### FTP Options
#### Options
| Key | Description |
| ------------ | ----------- |
| host | DNS host name to upload to
| root | The root directory of the remote site. Can be an absolute path, or if missing a trailing `/` it will be assumed to be a subdirectory of the remote user's home directory
| username | User name to login to the remote host with
| password | (optional) Password to login to the remote host with
| port | (optional) Port number to connect to if the target is not listening on the default
| ssl | (optional) Connect to the FTP target host over a secure SSL-FTP connection
| timeout | (optional) Time in seconds to wait for a connection attempt
| transferMode | (optional) The transfer mode. Must be either ASCII or BINARY
| utf8 | (optional) Set the connection to UTF-8 mode
| passive | (optional) Force FTP to use "passive" mode
| ignorePassiveAddress | (optional) Ignore the IP address returned when setting up a passive connection. Useful if a server is behind a NAT device. Requires PHP >= 5.6.18
#### Example
```
staging:
protocol: ftp
options:
host: example.com
root: my-site
username: deploy
password: 'your password goes here'
```
**NOTE:** In the above example, the root directory is a subdirectory of the
remote user's home directory called `my-site/`, e.g. `/home/deploy/my-site/`.
### SFTP Options
#### Options
| Key | Description |
| --------------- | ----------- |
| host | DNS host name to upload to
| root | The root directory of the remote site. Can be an absolute path, or if missing a trailing `/` it will be assumed to be a subdirectory of the remote user's home directory
| username | User name to login to the remote host with
| password | (optional) Password to login to the remote host with
| privateKey | (optional) Full path to private key file to for key exchange if **not** using password authentication
| useAgent | (optional) Set to `true` if using a private key, and you don't want to use the system SSH agent
| port | (optional) Port number to connect to if the target is not listening on the default
| timeout | (optional) Time in seconds to wait for a connection attempt
| hostFingerprint | (optional) The public key fingerprint of the deployment target
**NOTE:** Either a `password` or `privateKey` **must** be set.
#### Example: Password Login
```
production:
protocol: sftp
options:
host: example.com
username: deploy
password: 'your password goes here'
root: /var/www/sites/example.com
```
#### Example: Key-Based Login
```
production:
protocol: sftp
options:
host: example.com
username: deploy
privateKey: /home/your_home_dir/.ssh/id_rsa
root: /var/www/sites/example.com
```
### Setting Permissions
You can control the permissions of **newly created** files and directories by
adding a `permissions` key under `options`.
By default, Simple Deploy will set files to `0664` and directories to `0775`,
but if you need less restricted permissions (not recommended) you can set
them like:
```
options:
permissions:
file: 0666
dir: 0777
```
Of course more secure values are also possible and recommended.
### Editing
A very simple editor is also available by adding the `--edit` option to the
command.
```
php app/nut setup:deploy --edit
```
#### Example: Editing the configuration for the "production" target
```
php app/nut setup:deploy --edit production
```