Merge branch 'develop-v4' into master-v4

Author: mbtamuli

.github/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Community Guidelines
+
+This guide details how to get involve in EasyEngine commmunity. Please read this carefully.
+
+
+
+## How to get help?
+
+Please attach the output of following command when open a new support request.
+
+```bash
+lsb_release -a
+ee -v
+ee info
+wp --allow-root --info
+```
+
+### Where to create issue?
+
+For free support, please use - http://community.rtcamp.com/c/easyengine
+
+Please do NOT clutter github issue tracker here with support requests. It hampers development speed of this project.
+
+
+### Pull Requests
+
+When submitting your code please follow this coding standerds - http://docs.rtcamp.com/easyengine/dev/python/
+
+
+### EasyEngine Chat
+
+Developer & contributor discussion: https://gitter.im/rtCamp/easyengine
+
+Please do NOT use chat for technical support. Chat is limited to developer & contributor disucssion related to EasyEngine future.

.github/ISSUE_TEMPLATE

@@ -0,0 +1,9 @@
+This issue tracker is only for issues related to EasyEngine. Please use http://community.rtcamp.com/c/easyengine for support questions.
+
+If you feel the issue is a EasyEngine core specific issue, please attach the output of the following commands.
+
+System Information
+- [ ] lsb_release -a
+- [ ] ee -v
+- [ ] ee info
+- [ ] wp --allow-root --info

.github/ISSUE_TEMPLATE.md

@@ -1,4 +1,4 @@
-sudo: false
+sudo: required
 
 language: php
 php: 7.1

.github/PULL_REQUEST_TEMPLATE

@@ -1,172 +1,40 @@
 # EasyEngine v4
 
-[![Build Status](https://travis-ci.org/EasyEngine/easyengine.svg?branch=release%2Fv4)](https://travis-ci.org/EasyEngine/easyengine)
+[![Build Status](https://travis-ci.org/EasyEngine/easyengine.svg?branch=master%2Fv4)](https://travis-ci.org/EasyEngine/easyengine)
+
 ## Requirements
 
 * Docker
+* Docker-Compose
+* PHP CLI
+* PHP Modules - `curl`, `sqlite3`, `pcntl`
 
 ## Installing
 
-Once you've verified requirements, download the [setup.sh](http://rt.cx/eev4) file using `wget` or `curl` and execute it:
+### Mac
 
-```bash
-wget rt.cx/eev4 -O ee4-setup && bash ee4-setup
-```
-
-If EE was installed successfully, you should see something like this when you run `ee cli version`:
+Once you have verified the requirements exist, download the `easyengine.phar` file using `wget` or `curl` and give it executable permissions:
 
 ```bash
-$ ee cli version
-EE 0.0.1
+wget -O /usr/local/bin/ee https://raw.githubusercontent.com/EasyEngine/easyengine-builds/master/phar/easyengine.phar
+chmod +x /usr/local/bin/ee
 ```
 
-## Commands
-
-### ee4 site
-
-Creates, lists and deletes WordPress websites.
-
-~~~
-ee site
-~~~
-
-
-**EXAMPLES**
-
-    # Create simple WordPress website. No parameter flag defaults to --wp
-    $ ee site create site.test
-    Success: ee4_nginx-proxy container launched successfully.
-    Configuring project...
-    Creating WordPress site site.test...
-    Copying configuration files...
-    Success: Configuration files copied.
-    Updating configuration files...
-    Success: Configuration files updated.
-    Success: Network started.
-    Success: Site connected to ee4_nginx-proxy.
-    Success: Host entry successfully added.
-    Checking and verifying site-up status. This may take some time.
-    ..........
-    Installing WordPress site...
-    Success: http://site.test has been created successfully!
-    Access phpMyAdmin :	pma.site.test
-    Access mail :	mail.site.test
-    Site Title :	site.test
-    Username :	admin
-    Password :	DrwKpMsaGiuI
-    DB Password :	Si23era8cnmR
-    E-Mail :	[email protected]
-    Site entry created.
-
-    $ ee site create site2.test --wpredis --user=admin --pass=admin [email protected] --title="Site by EasyEngine"
-    Configuring project...
-    Creating WordPress site site2.test...
-    Copying configuration files...
-    Success: Configuration files copied.
-    Updating configuration files...
-    Success: Configuration files updated.
-    Success: Network started.
-    Success: Site connected to ee4_nginx-proxy.
-    Success: Site connected to ee4_redis.
-    Success: Host entry successfully added.
-    Checking and verifying site-up status. This may take some time.
-    ..........
-    Installing WordPress site...
-    Success: http://site2.test has been created successfully!
-    Access phpMyAdmin :	pma.site2.test
-    Access mail :	mail.site2.test
-    Site Title :	Site by EasyEngine
-    Username :	admin
-    Password :	admin
-    DB Password :	B4B6ggCBcJyE
-    E-Mail :	[email protected]
-    Site entry created.
-
-    $ ee site list
-    List of Sites:
-
-      - site.test
-      - site2.test
-
-    $ ee site delete site.test
-    [site.test] Docker Containers removed.
-    [site.test] Disconnected from Docker network nginx-proxy
-    [site.test] Docker network nginx-proxy removed.
-    [sudo] password for mrrobot: 
-    [site.test] site root removed.
-    Removing database entry.
-    Site site.test deleted.
-
-### ee site create
-
-~~~
-ee site create <site-name> [--wp|--wpredis] [--letsencrypt] [--title=<title>] [--user=<username>] [--pass=<password>] [--email=<email>]
-~~~
-
-Creates WordPress site. 
-
-**OPTIONS**
+### Linux
 
-	[--wp]
-		Creates simple WordPress website.
+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.
 
-	[--wpredis]
-		Creates WordPress website with Redis caching.
-
-	[--letsencrypt]
-		Generates letsencrypt certificates for the site.
-
-    [--title=<title>]
-        Title of website.
-
-    [--user=<username>]
-	    Username of the WordPress administrator.
-	 
-	[--pass=<password>]
-	    Password for the WordPress administrator.
-	
-	[--email=<email>]
-	    E-Mail of the WordPress administrator.
-
-### ee site list
-
-~~~
-ee site list
-~~~
-
-Lists all the sites created by EasyEngine.
-
-### ee site delete
-
-~~~
-ee site delete <site-name>
-~~~
-
-Deletes the given site if it was created by EasyEngine.
-
-### ee wp
-
-Run all the wp commands for site created by EasyEngine.
-
-~~~
-ee wp
-~~~
-
-### Usage
+```bash
+wget -qO ee rt.cx/ee4beta && sudo bash ee
+```
 
-~~~
-ee wp <site-name> <wp-command>
-~~~
+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
 
-**EXAMPLES**
+```bash
+wget -O /usr/local/bin/ee https://raw.githubusercontent.com/EasyEngine/easyengine-builds/master/phar/easyengine.phar
+chmod +x /usr/local/bin/ee
+```
 
-    $ ee wp site.test plugin list
-    +---------+----------+-----------+---------+
-    | name    | status   | update    | version |
-    +---------+----------+-----------+---------+
-    | akismet | inactive | available | 4.0.2   |
-    | hello   | inactive | none      | 1.6     |
-    +---------+----------+-----------+---------+
+## Usage
 
-    $ ee wp site.test user create author1 [email protected] --user_pass=password --role=administrator
-    Success: Created user 2.
+EasyEngine will currently only run with root privileges. You can run `ee help` or `ee help site` to get all the details about the various commands and subcommands that you can run.

.github/SUPPORT.md

@@ -1 +1 @@
-0.0.1
+4.0.0-beta.1

.travis.yml

@@ -0,0 +1,4 @@
+bin
+===
+
+Entrypoint to the php scripts which also sets the required enviournment variables.