Skip to content

Commit f0221c3

Browse files
committed
Merge branch 'readme-for-all' of https://github.com/mrrobot47/easyengine into readme-for-all
2 parents b0c690a + 683b6da commit f0221c3

File tree

1 file changed

+1
-170
lines changed

1 file changed

+1
-170
lines changed

README.md

+1-170
Original file line numberDiff line numberDiff line change
@@ -1,172 +1,3 @@
11
# EasyEngine v4
22

3-
[![Build Status](https://travis-ci.org/EasyEngine/easyengine.svg?branch=release%2Fv4)](https://travis-ci.org/EasyEngine/easyengine)
4-
## Requirements
5-
6-
* Docker
7-
8-
## Installing
9-
10-
Once you've verified requirements, download the [setup.sh](http://rt.cx/eev4) file using `wget` or `curl` and execute it:
11-
12-
```bash
13-
wget rt.cx/eev4 -O ee4-setup && bash ee4-setup
14-
```
15-
16-
If EE was installed successfully, you should see something like this when you run `ee cli version`:
17-
18-
```bash
19-
$ ee cli version
20-
EE 0.0.1
21-
```
22-
23-
## Commands
24-
25-
### ee4 site
26-
27-
Creates, lists and deletes WordPress websites.
28-
29-
~~~
30-
ee site
31-
~~~
32-
33-
34-
**EXAMPLES**
35-
36-
# Create simple WordPress website. No parameter flag defaults to --wp
37-
$ ee site create site.test
38-
Success: ee4_nginx-proxy container launched successfully.
39-
Configuring project...
40-
Creating WordPress site site.test...
41-
Copying configuration files...
42-
Success: Configuration files copied.
43-
Updating configuration files...
44-
Success: Configuration files updated.
45-
Success: Network started.
46-
Success: Site connected to ee4_nginx-proxy.
47-
Success: Host entry successfully added.
48-
Checking and verifying site-up status. This may take some time.
49-
..........
50-
Installing WordPress site...
51-
Success: http://site.test has been created successfully!
52-
Access phpMyAdmin : pma.site.test
53-
Access mail : mail.site.test
54-
Site Title : site.test
55-
Username : admin
56-
Password : DrwKpMsaGiuI
57-
DB Password : Si23era8cnmR
58-
59-
Site entry created.
60-
61-
$ ee site create site2.test --wpredis --user=admin --pass=admin [email protected] --title="Site by EasyEngine"
62-
Configuring project...
63-
Creating WordPress site site2.test...
64-
Copying configuration files...
65-
Success: Configuration files copied.
66-
Updating configuration files...
67-
Success: Configuration files updated.
68-
Success: Network started.
69-
Success: Site connected to ee4_nginx-proxy.
70-
Success: Site connected to ee4_redis.
71-
Success: Host entry successfully added.
72-
Checking and verifying site-up status. This may take some time.
73-
..........
74-
Installing WordPress site...
75-
Success: http://site2.test has been created successfully!
76-
Access phpMyAdmin : pma.site2.test
77-
Access mail : mail.site2.test
78-
Site Title : Site by EasyEngine
79-
Username : admin
80-
Password : admin
81-
DB Password : B4B6ggCBcJyE
82-
83-
Site entry created.
84-
85-
$ ee site list
86-
List of Sites:
87-
88-
- site.test
89-
- site2.test
90-
91-
$ ee site delete site.test
92-
[site.test] Docker Containers removed.
93-
[site.test] Disconnected from Docker network nginx-proxy
94-
[site.test] Docker network nginx-proxy removed.
95-
[sudo] password for mrrobot:
96-
[site.test] site root removed.
97-
Removing database entry.
98-
Site site.test deleted.
99-
100-
### ee site create
101-
102-
~~~
103-
ee site create <site-name> [--wp|--wpredis] [--letsencrypt] [--title=<title>] [--user=<username>] [--pass=<password>] [--email=<email>]
104-
~~~
105-
106-
Creates WordPress site.
107-
108-
**OPTIONS**
109-
110-
[--wp]
111-
Creates simple WordPress website.
112-
113-
[--wpredis]
114-
Creates WordPress website with Redis caching.
115-
116-
[--letsencrypt]
117-
Generates letsencrypt certificates for the site.
118-
119-
[--title=<title>]
120-
Title of website.
121-
122-
[--user=<username>]
123-
Username of the WordPress administrator.
124-
125-
[--pass=<password>]
126-
Password for the WordPress administrator.
127-
128-
[--email=<email>]
129-
E-Mail of the WordPress administrator.
130-
131-
### ee site list
132-
133-
~~~
134-
ee site list
135-
~~~
136-
137-
Lists all the sites created by EasyEngine.
138-
139-
### ee site delete
140-
141-
~~~
142-
ee site delete <site-name>
143-
~~~
144-
145-
Deletes the given site if it was created by EasyEngine.
146-
147-
### ee wp
148-
149-
Run all the wp commands for site created by EasyEngine.
150-
151-
~~~
152-
ee wp
153-
~~~
154-
155-
### Usage
156-
157-
~~~
158-
ee wp <site-name> <wp-command>
159-
~~~
160-
161-
**EXAMPLES**
162-
163-
$ ee wp site.test plugin list
164-
+---------+----------+-----------+---------+
165-
| name | status | update | version |
166-
+---------+----------+-----------+---------+
167-
| akismet | inactive | available | 4.0.2 |
168-
| hello | inactive | none | 1.6 |
169-
+---------+----------+-----------+---------+
170-
171-
$ ee wp site.test user create author1 [email protected] --user_pass=password --role=administrator
172-
Success: Created user 2.
3+
[![Build Status](https://travis-ci.org/EasyEngine/easyengine.svg?branch=release%2Fv4)](https://travis-ci.org/EasyEngine/easyengine)

0 commit comments

Comments
 (0)