|
| 1 | +# EasyEngine v4 |
| 2 | + |
| 3 | +<img width="150" height="150" src="https://easyengine.io/wp-content/uploads/2015/11/cropped-favicon-easyengine.png" alt="EasyEngine Logo" align="right" /> |
| 4 | + |
| 5 | +[](https://travis-ci.org/EasyEngine/easyengine) |
| 6 | +[](http://slack.easyengine.io/) |
| 7 | + |
| 8 | +## Requirements |
| 9 | + |
| 10 | +* Docker |
| 11 | +* Docker-Compose |
| 12 | +* PHP CLI (>=7.1) |
| 13 | +* PHP Modules - `curl`, `sqlite3`, `pcntl` |
| 14 | + |
| 15 | +## Installing |
| 16 | + |
| 17 | +### Linux |
| 18 | + |
| 19 | +For Linux, we have created an installer script which will install all the dependencies for you. We have tested this on Ubuntu 14.04, 16.04, 18.04 and Debian 8. |
| 20 | + |
| 21 | +```bash |
| 22 | +wget -qO ee https://rt.cx/ee4beta && sudo bash ee |
| 23 | +``` |
| 24 | + |
| 25 | +Even if the script doesn't work for your distribution, you can manually install the dependencies and then run the following commands to install EasyEngine |
| 26 | + |
| 27 | +```bash |
| 28 | +wget -O /usr/local/bin/ee https://raw.githubusercontent.com/EasyEngine/easyengine-builds/master/phar/easyengine.phar |
| 29 | +chmod +x /usr/local/bin/ee |
| 30 | +``` |
| 31 | + |
| 32 | +### Tab completions |
| 33 | + |
| 34 | +EasyEngine also comes with a tab completion script for Bash and ZSH. Just download [ee-completion.bash](https://raw.githubusercontent.com/EasyEngine/easyengine/develop-v4/utils/ee-completion.bash) and source it from `~/.bash_profile`: |
| 35 | + |
| 36 | +```bash |
| 37 | +source /FULL/PATH/TO/ee-completion.bash |
| 38 | +``` |
| 39 | + |
| 40 | +Don't forget to run `source ~/.bash_profile` afterwards. |
| 41 | + |
| 42 | +If using zsh for your shell, you may need to load and start `bashcompinit` before sourcing. Put the following in your `.zshrc`: |
| 43 | + |
| 44 | +```bash |
| 45 | +autoload bashcompinit |
| 46 | +bashcompinit |
| 47 | +source /FULL/PATH/TO/ee-completion.bash |
| 48 | +``` |
| 49 | + |
| 50 | +## Usage |
| 51 | + |
| 52 | +To get started with EasyEngine and create a wordpress site, run |
| 53 | + |
| 54 | +``` |
| 55 | +ee site create example.com --type=wp |
| 56 | +``` |
| 57 | + |
| 58 | +Need a wordpress site with caching? Try |
| 59 | + |
| 60 | +``` |
| 61 | +ee site create example.com --type=wp --cache |
| 62 | +``` |
| 63 | + |
| 64 | +Need a wordpress multi-site with page cache? |
| 65 | +``` |
| 66 | +ee site create example.com --type=wp --mu=wpsubdir --cache |
| 67 | +``` |
| 68 | + |
| 69 | +Need a plain and simple html site? |
| 70 | +``` |
| 71 | +ee site create example.com |
| 72 | +``` |
| 73 | + |
| 74 | +Want to play around with your new site? |
| 75 | +``` |
| 76 | +ee shell example.com |
| 77 | +``` |
| 78 | + |
| 79 | +Want to know more? Checkout readme of these commands - |
| 80 | + * [site command](https://github.com/EasyEngine/site-command/) |
| 81 | + * [site-wp command](https://github.com/EasyEngine/site-wp-command/) |
| 82 | + * [cron command](https://github.com/EasyEngine/cron-command/) |
| 83 | + * [shell command](https://github.com/EasyEngine/shell-command/) |
| 84 | + |
| 85 | +Note: :warning: EasyEngine will currently only run with root privileges. You can run `ee help`, `ee help site` and `ee help site create` to get all the details about the various commands and subcommands that you can run. |
| 86 | + |
| 87 | +## Development |
| 88 | + |
| 89 | +Development of easyengine is done entirely on GitHub. |
| 90 | + |
| 91 | +We've used [wp-cli](https://github.com/wp-cli/wp-cli/) framework as a base and built EasyEngine on top of it. |
| 92 | + |
| 93 | +This repo contains main core of easyengine (the framework). |
| 94 | +All top level commands(except `ee cli`) i.e. `ee site`, `ee shell` have their own repos. |
| 95 | + |
| 96 | +Currently we have following commands which are bundled by default in EasyEngine: |
| 97 | + |
| 98 | +* [site command](https://github.com/EasyEngine/site-command/) |
| 99 | +* [shell command](https://github.com/EasyEngine/shell-command/) |
| 100 | + |
| 101 | +In future, community will be able to make their own packages and commands! |
| 102 | + |
| 103 | +## Contributing |
| 104 | + |
| 105 | +We warmheartedly welcome all contributions however and in whatever capacity you can either through Pull Requests or by reporting Issues. You can contribute here or in any of the above mentioned commands repo. |
| 106 | + |
| 107 | +## Donations |
| 108 | + |
| 109 | +[](http://rt.cx/eedonate) |
| 110 | +[](https://bitpay.com/417008/donate) |
0 commit comments