RZ Deployer

A simple PHP command-line tool to create virtual hosts and create essential webserver files.

We recommand using Nginx instead of Apache as it's easier to setup multi-users virtual hosts.

What does it do

• Create a system user for each virtual host and generate a random password
• Create a home folder into your webserver root path (ex: /var/www/vhosts)
• Create a MySQL user and database
• Create a virtual host config file (apache2 or nginx) in your sites-available
• Create a symlink into your site-enabled folder

Before using deployer

• Make sure /var/www/vhosts is writable or change it in your config.yml
• Install a webserver, php-fpm and MySQL/MariaDB

How to use it

• Clone current repository and cd rzdeployer
• Install Composer
• Run php composer.phar install to install dependencies and create the autoloader
• Copy conf/config.homebrew.yml or conf/config.default.yml to conf/config.yml
• Edit your own configuration
• Be sure to have at least PHP 5.6 installed in CLI mode.
• Run sudo bin/deployer all:create $USERNAME $TEMPLATE $PASSWORD replacing variable with your own. We provide 3 templates: roadiz, symfony and plain. You can leave $PASSWORD empty, it will generate random passwords for SSH user and database.

Apache and PHP-FPM

We always ensure that Unix user and PHP user can read/write the same files without messing your file permissions. It's why we work with PHP-FPM, creating a different pool for each user so that PHP will run as your user, not www-data. To use Apache with PHP-FPM you must run at least with Apache 2.4 and enable rewrite, proxy, proxy_fcgi, setenvif modules (see our Vagrantfile for a typical Apache setup).

Nginx will work seamlessly with PHP-FPM, we recommand using it over Apache for beginners.

Passwords

RZ Deployer uses openssl to generate and encrypt passwords. Be sure it’s correcty setup on your unix server.

SSH key

RZ Deployer can automatically populate your new user with your existing SSH public keys to avoid typing your password. Just copy your ~/.ssh/*.pub public keys to the authorized_keys/ folder.

Configuration

Check conf/config.default.yml. Each commented option has a default value and is optional.

deployer:
  database:
    # Database user to use for CLI creations and deletions
    user: root
    # CLI user password (enter your MySQL root password)
    password: root
    
    # Default localhost
    #host: localhost
    
    # Default password length: 12 characters
    #password_length: 12
    
  user:
    # This value defined each unix user home root path on system.
    path: "/var/www/vhosts"
    # This value defined each unix base group.
    group: "www-data"
    # Default shell to attribute for each user.
    shell: "/bin/bash"
    
    # If you need to add an other group to
    # generated user: default null
    #allowssh_group: "ssh_user"
    
    # Default server root folder
    # for each new user.
    #server_root: "htdocs"
    
    # Default password length: 12 characters
    #password_length: 12
    
  web_server:
    # Webserver type (apache22, apache24 or nginx).
    type: "nginx"
    # Webserver running user.
    user: "www-data"
    
    # Web server port. Default 80
    #port: 80
    
    # Suffix to append after username to create website domain name (default .dev).
    domain_suffix: ".com"
    # Path where web-server stores available virtual host files.
    available_path: "/etc/nginx/sites-available"
    # Path where web-server stores enabled virtual host files.
    enabled_path: "/etc/nginx/sites-enabled"

  php_fpm:
    # PHP version installed on system.
    version: "7.1"
    # Path where PHP-FPM pool files are stored.
    pool_path: "/etc/php/7.1/fpm/pool.d"
    # Path where PHP-FPM socket files are created.
    socket_path: "/var/run"

Files

RZ Deployer will generate the following file tree in your webserver root :

• (/var/www/vhosts)/www.yourdomain.com [user:www-data:0750]
  • /htdocs [user:www-data:0750]
    • index.php (with phpinfo(); method)
  • /log [user:www-data:0770]
    • access.log
    • error.log
    • fpm-error.log
  • /private [user:www-data:0750]
    • /backups
    • /git
    • /dkim [user:www-data:0700]
  • /.ssh [user:www-data:0700]

Logs

Nginx, Apache and PHP-fpm logs will be generated into each virtual host log folder. Do not forget to update your logrotate.d script, for example:

• In /etc/logrotate.d/nginx

# After existing content…
/var/www/vhosts/*/log/*.nginx.log {
    daily
    missingok
    rotate 10
    size 100M
    su www-data www-data
    compress
    delaycompress
    notifempty
    create 0664 root root
    su root root
    sharedscripts
    prerotate
        if [ -d /etc/logrotate.d/httpd-prerotate ]; then \
            run-parts /etc/logrotate.d/httpd-prerotate; \
        fi; \
    endscript
    postrotate
        [ ! -f /var/run/nginx.pid ] || kill -USR1 `cat /var/run/nginx.pid`
    endscript
}

• In /etc/logrotate.d/php5-fpm

# After existing content…
/var/www/vhosts/*/log/fpm-php.log {
    weekly
    rotate 12
    missingok
    size 100M
    notifempty
    compress
    delaycompress
    postrotate
        invoke-rc.d php5-fpm reopen-logs > /dev/null
    endscript
}

Test

# Copy default configuration
cp conf/config.vagrant.yml conf/config.yml 
# Set .dev as domain-suffix.

# Launch Vagrant VM
vagrant up
# Log into your VM
vagrant ssh
# Go to your shared folder
cd /vagrant

# Create user, database and application
sudo bin/deployer all:create test plain password

# Restart services
sudo service php7.1-fpm restart
sudo service nginx restart

# Go back to your computer
exit
# Add 192.168.34.10 to your hosts file under test.dev domain name
sudo nano /etc/hosts
# Check test.dev
open http://test.dev