Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/easyengine/easyengine
Command-line control panel for Nginx Server to manage WordPress sites running on Nginx, PHP, MySQL, and Let's Encrypt
https://github.com/easyengine/easyengine
automation docker easyengine hacktoberfest linux macos nginx optimization performance php wordpress
Last synced: about 1 month ago
JSON representation
Command-line control panel for Nginx Server to manage WordPress sites running on Nginx, PHP, MySQL, and Let's Encrypt
- Host: GitHub
- URL: https://github.com/easyengine/easyengine
- Owner: EasyEngine
- License: mit
- Created: 2012-08-14T06:00:02.000Z (about 12 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-28T16:20:33.000Z (6 months ago)
- Last Synced: 2024-05-29T07:09:05.102Z (6 months ago)
- Topics: automation, docker, easyengine, hacktoberfest, linux, macos, nginx, optimization, performance, php, wordpress
- Language: PHP
- Homepage: https://easyengine.io
- Size: 5.62 MB
- Stars: 2,095
- Watchers: 107
- Forks: 432
- Open Issues: 103
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# EasyEngine v4
[](https://github.com/EasyEngine/easyengine/actions/workflows/test_and_build.yml)
[](https://github.com/EasyEngine/easyengine/releases) [](https://packagist.org/packages/easyengine/easyengine)
EasyEngine makes it greatly easy to manage nginx, a fast web-server software that consumes little memory when handling increasing volumes of concurrent users.
## Requirements
* Docker
* Docker-Compose
* PHP CLI (>=7.1)
* PHP Modules - `curl`, `sqlite3`, `pcntl`
## Installing
### Linux
For Linux, we have created an installer script that will install all the dependencies for you. We have tested this on Ubuntu 14.04, 16.04, 18.04, 20.04, 22.04 and Debian 8, Debian 10.
```bash
wget -qO ee https://rt.cx/ee4 && sudo bash ee
```
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
```bash
wget -O /usr/local/bin/ee https://raw.githubusercontent.com/EasyEngine/easyengine-builds/master/phar/easyengine.phar
chmod +x /usr/local/bin/ee
```
### Tab completions
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`:
```bash
source /FULL/PATH/TO/ee-completion.bash
```
Don't forget to run `source ~/.bash_profile` afterwards.
If using zsh for your shell, you may need to load and start `bashcompinit` before sourcing. Put the following in your `.zshrc`:
```bash
autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/ee-completion.bash
```
## Usage
To get started with EasyEngine and create a wordpress site, run
```
ee site create example.com --type=wp
```
Need a wordpress site with caching? Try
```
ee site create example.com --type=wp --cache
```
Need a wordpress multi-site with page cache?
```
ee site create example.com --type=wp --mu=subdir --cache
```
Need a plain and simple html site?
```
ee site create example.com
```
Want to play around with your new site?
```
ee shell example.com
```
Want to know more? Checkout readme of these commands -
* [site command](https://github.com/EasyEngine/site-command/)
* [site-wp command](https://github.com/EasyEngine/site-wp-command/)
* [cron command](https://github.com/EasyEngine/cron-command/)
* [shell command](https://github.com/EasyEngine/shell-command/)
Note: :warning: EasyEngine will currently only run with root privileges. You can run `ee help`, `ee help site` and `ee help site create --type=wp` to get all the details about the various commands and subcommands that you can run.
## Development
Development of easyengine is done entirely on GitHub.
We've used [wp-cli](https://github.com/wp-cli/wp-cli/) framework as a base and built EasyEngine on top of it.
This repo contains the main core of easyengine (the framework).
All top level commands(except `ee cli`) i.e. `ee site`, `ee shell` have their own repos.
Currently, we have the following commands which are bundled by default in EasyEngine:
* [site command](https://github.com/EasyEngine/site-command/)
* [shell command](https://github.com/EasyEngine/shell-command/)
In future, the community will be able to make their own packages and commands!
## Contributing
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.
## Donations
[](http://rt.cx/eedonate)
## Does this interest you?
