Skip to content
This repository has been archived by the owner on Jun 3, 2020. It is now read-only.

Latest commit

 

History

History
101 lines (73 loc) · 4.36 KB

README.md

File metadata and controls

101 lines (73 loc) · 4.36 KB
Raw

Autopilot

Test

A tool for provisioning servers, maintaining WordPress sites and managing clients / projects.

screenshot

Requirements

Ubuntu 18.04 is the only supported operating system (for the master and slave hosts). Autopilot uses Ansible to update WordPress sites and provision servers, users and vhosts. To use Autopilot you need:

NOTE: The master host requires root access to the slave hosts.

Installation

  • Create a directory: mkdir ~/autopilot && cd ~/autopilot.
  • Download Autopilot script: curl -o ./autopilot https://raw.githubusercontent.com/sitepilot/autopilot/master/autopilot && chmod +x ./autopilot.
  • Download environment file and modify it to your needs: curl -o ./.env https://raw.githubusercontent.com/sitepilot/autopilot/master/.env.example && nano ./.env.
  • Run ./autopilot install to start the containers, install packages and migrate the database. NOTE: This will prompt for your Laravel Nova username and password.
  • Navigate to https://<SERVER IP>:<APP_HTTPS_PORT> and login (default user: admin@sitepilot.io, default pass: supersecret).

Update

  • Navigate to the Autopilot installation folder: cd ~/autopilot.
  • Update Autopilot script: curl -o ./autopilot https://raw.githubusercontent.com/sitepilot/autopilot/master/autopilot && chmod +x ./autopilot.
  • Run ./autopilot update to update the containers, packages and migrate the database.

Commands

  • ./autopilot server:inventory: Outputs the inventory in JSON format.
  • ./autopilot server:provision: Provision a server.
  • ./autopilot server:test: Test a server.
  • ./autopilot user:provision: Provision a user.
  • ./autopilot user:destroy: Destroy an user from the server.
  • ./autopilot user:test: Test a provisioned user.
  • ./autopilot database:provision: Provision a database.
  • ./autopilot database:destroy: Destroy a database from the server.
  • ./autopilot app:provision: Provision a app.
  • ./autopilot app:destroy: Destroy an app from the server.
  • ./autopilot app:cert:request: Request SSL certificate for app domains.
  • ./autopilot app:wp:install: Install WordPress in app.
  • ./autopilot app:wp:update: Update WordPress in app.
  • ./autopilot app:wp:search-replace {search} {replace}: Search and replace in WordPress database.
  • ./autopilot app:wp:login {username}: Login to the WordPress dashboard.
  • ./autopilot app:wp:check-state: Check WordPress for updates and installed plugins / themes.

Server Configuration

Packages & Services

The following packages/services will be installed and configured on servers (together with dependencies):

  • OpenLitespeed
  • LSPHP 7.4
  • Composer
  • WPCLI
  • UFW
  • Fail2Ban
  • OpenSSH (SFTP)
  • Docker
  • Docker Compose
  • Docker Redis 5
  • Docker MariaDB 10.4
  • phpMyAdmin 5

Users are isolated and allowed to use SFTP with password authentication (chroot directory /opt/sitepilot/users/%u).

Tools

  • phpMyAdmin: http://example.com/.sitepilot/pma/.
  • Health check: http://example.com/.sitepilot/health/.

Filesystem

  • Users folder: /opt/sitepilot/users.
  • App document root folder: /opt/sitepilot/users/{{ user.name }}/{{ app.name }}/live.
  • App logs folder: /opt/sitepilot/users/{{ user.name }}/{{ app.name }}/logs.
  • OpenLitespeed logs folder: /opt/sitepilot/services/olsws/logs.
  • OpenLitespeed temp folder: /opt/sitepilot/services/olsws/tmp.
  • Docker MySQL data folder: /opt/sitepilot/services/mysql/data.
  • Docker MySQL logs folder: /opt/sitepilot/services/mysql/logs.
  • Docker Redis data folder: /opt/sitepilot/services/redis/data.

Development

  • Clone this repository.
  • Copy the example environment file and modify it to your needs: cp .env.example .env.
  • Start the containers, install packages and migrate the database: ./autopilot install-dev. The Autopilot source files are mounted to the the autopilot container. NOTE: This will prompt for your Laravel Nova username and password.
  • Navigate to https://<SERVER IP>:<APP_HTTPS_PORT> and login (default user: admin@sitepilot.io, default pass: supersecret).

License

MIT / BSD

Author

Autopilot was created in 2020 by Nick Jansen.