Skip to content

Commit b4aa0bc

Browse files
author
shital.rtcamp
committed
created man pages and added argument if self.py
1 parent d7db8d0 commit b4aa0bc

File tree

3 files changed

+317
-3
lines changed

3 files changed

+317
-3
lines changed

‎docs/ee.8‎

Lines changed: 312 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,312 @@
1+
.TH ee 8 "EasyEngine (ee) version: 2.2.1" "Oct 16,2014" "EasyEngine"
2+
.SH NAME
3+
.B EasyEngine (ee)
4+
\- Manage Nginx Based Websites.
5+
.SH SYNOPSIS
6+
ee [ --version | --help | info | stack | site | debug | update ]
7+
.TP
8+
ee stack [ install | remove | purge ] [ --web | --mail | --all | --nginx | --php | --mysql | --postfix | --adminer | --phpmyadmin | --wpcli | --utils ]
9+
.TP
10+
ee stack [ status | start | stop | reload | restart ]
11+
.TP
12+
ee site [ list | info | show | enable | disable | edit ] [ example.com ]
13+
.TP
14+
ee site create example.com [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--basic | --wpsc | --w3tc | --wpfc]]
15+
.TP
16+
ee site update example.com [ --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--basic | --wpsc | --w3tc | --wpfc]]
17+
.TP
18+
ee site delete example.com [--db | --files | --all | --no-prompt ]
19+
.TP
20+
ee debug [ -i | --nginx | --rewrite | --php | --fpm | --mysql ] [--stop ]
21+
.TP
22+
ee debug example.com [ -i | --nginx | --rewrite | --wp ] [--stop ]
23+
.TP
24+
ee secure [ --auth | --port | --ip ]
25+
.SH DESCRIPTION
26+
EasyEngine aka ee is the opensource project developed with the purpose to automate web-server configuration.
27+
.br
28+
EasyEngine is the collection of shell scripts that provides automation for the web-server
29+
.br
30+
installation, site creation, services debugging & monitoring.
31+
.SH OPTIONS
32+
.TP
33+
.B --version
34+
.br
35+
Display easyengine (ee) version information.
36+
.TP
37+
.B info
38+
.br
39+
ee info - Display Nginx, PHP, MySQL and ee common location information
40+
.br
41+
ee site info - Diplay given website details like enable, disable. weboot and log files.
42+
.TP
43+
.B --help
44+
.br
45+
Display easyengine (ee) help.
46+
.TP
47+
.B stack
48+
.TP
49+
.B install [ --all | --web | --mail | --nginx | --php | --mysql | --postfix | --adminer | --phpmyadmin | --wpcli | --utils ]
50+
.br
51+
Install Nginx PHP5 MySQL Postfix stack Packages if not used with
52+
.br
53+
any options.Installs specific package if used with option.
54+
.TP
55+
.B remove [ --all | --web | --mail | --nginx | --php | --mysql | --postfix | --adminer | --phpmyadmin | --wpcli | --utils ]
56+
.br
57+
Remove Nginx PHP5 MySQL Postfix stack Packages if not used with
58+
.br
59+
any options. Remove specific package if used with option.
60+
.TP
61+
.B purge [ --all | --web | --mail | --nginx | --php | --mysql | --postfix | --adminer | --phpmyadmin | --wpcli | --utils ]
62+
.br
63+
Purge Nginx PHP5 MySQL Postfix stack Packages if not used with any
64+
.br
65+
options.Purge specific package if used with option.
66+
.TP
67+
.B status
68+
.br
69+
Display status of NGINX, PHP5-FPM, MySQL, Postfix services.
70+
.TP
71+
.B start
72+
.br
73+
Start services NGINX, PHP5-FPM, MySQL, Postfix.
74+
.TP
75+
.B stop
76+
.br
77+
Stop services NGINX, PHP5-FPM, MySQL, Postfix.
78+
.TP
79+
.B reload
80+
.br
81+
Reload services NGINX, PHP5-FPM, MySQL, Postfix.
82+
.TP
83+
.B restart
84+
.br
85+
Restart services NGINX, PHP5-FPM, MySQL, Postfix.
86+
.TP
87+
.B site
88+
.br
89+
.TP
90+
.B cd [ example.com ]
91+
.br
92+
Change directory to webroot of specified site in subshell.
93+
.TP
94+
.B log [ example.com ]
95+
.br
96+
monitor access and error logs for site specified.
97+
.TP
98+
.B list [ enable | available ]
99+
.br
100+
Lists all available sites from /etc/nginx/sites-enabled/
101+
.br
102+
by default & enable argument. Display sites list from
103+
.br
104+
/etc/nginx/sites-available/ if used with available option.
105+
.TP
106+
.B info [ example.com ]
107+
.br
108+
prints information about site such as access log, error log
109+
.br
110+
location and type of site.
111+
.TP
112+
.B show [ example.com ]
113+
.br
114+
Display NGINX configuration of site.
115+
.TP
116+
.B enable [ example.com ]
117+
.br
118+
Enable site by creating softlink with site file in
119+
.br
120+
/etc/nginx/sites-available to /etc/nginx/sites-enabled/.
121+
.TP
122+
.B disable [ example.com ]
123+
.br
124+
Disable site by Destroying softlink with site file in
125+
.br
126+
/etc/nginx/sites-available to /etc/nginx/sites-enabled/.
127+
.TP
128+
.B edit [ example.com ]
129+
.br
130+
Edit NGINX configuration of site.
131+
.TP
132+
.B create [ example.com ] [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--basic | --wpsc | --w3tc | --wpfc]]
133+
.br
134+
Create new site according to given options. If no options provided
135+
.br
136+
create static site with html only.
137+
.TP
138+
.B update [ example.com ] [ --html | --php | --mysql] [[--wp | --wpsubdir | --wpsubdomain ] [--basic | --wpsc | --w3tc | --wpfc]]
139+
.br
140+
Update site configuration according to specified options.
141+
.TP
142+
.B delete [ example.com ] [--no-prompt ] [ --db | --files ]
143+
.br
144+
Delete site i.e webroot, database, ad configuration permenantly.
145+
.TP
146+
.B debug [ -i | --nginx | --php | --mysql | --rewrite | --fpm ] [ --start | --stop ]
147+
.br
148+
Starts server level debugging. If used without arguments starts debugging
149+
.br
150+
all services, else debug only service provided with argument. Stop
151+
.br
152+
Debugging if used with --stop argument.
153+
.TP
154+
.B debug example.com [ -i | --nginx | --rewrite | --wp ] [ --start | --stop ]
155+
.br
156+
Starts site level debugging. If used without arguments starts debugging all
157+
.br
158+
services, else debug only service provided with argument. Stop Debugging
159+
.br
160+
if used with --stop argument.
161+
.TP
162+
.B secure [ --auth | --port ]
163+
.br
164+
Update security settings.
165+
.TP
166+
.B clean [ --fastcgi | --opcache | --memcache | --all ]
167+
.br
168+
Clean NGINX fastCGI cache, Opcache, Memcache.
169+
.br
170+
Clean NGINX fastCGI cache if no option specified.
171+
.SH ARGUMENTS
172+
.TP
173+
.B -i
174+
.br
175+
setup intractive mode while used with debug.
176+
.TP
177+
.B --nginx
178+
.br
179+
used with ee debug command. used to start or stop nginx debugging.
180+
.TP
181+
.B --php
182+
.br
183+
used with ee debug command. used to start or stop php debugging.
184+
.TP
185+
.B --mysql
186+
.br
187+
used with ee debug command. used to start or stop mysql debugging.
188+
.TP
189+
.B --rewrite
190+
.br
191+
used with ee debug command. used to start or stop nginx rewrite rules debugging.
192+
.TP
193+
.B --fpm
194+
.br
195+
used with ee debug command. used to start or stop fpm debugging.
196+
.TP
197+
.B --wp
198+
.br
199+
used with ee debug command. used to start or stop wordpress site debugging.
200+
.TP
201+
.B --start
202+
.br
203+
used with ee debug command. used to stop debugging.
204+
.TP
205+
.B --stop
206+
.br
207+
used with ee debug command. used to stop debugging.
208+
.TP
209+
.B --html
210+
.br
211+
Create a HTML website.
212+
.TP
213+
.B --php
214+
.br
215+
Create a PHP website.
216+
.TP
217+
.B --mysql
218+
.br
219+
Create a PHP+MySQL website.
220+
.TP
221+
.B --wp
222+
.br
223+
Create a WordPress Website.
224+
.TP
225+
.B --wpsubdir
226+
.br
227+
Create a Wordpress Multisite with Sub Directories Setup.
228+
.TP
229+
.B --wpsubdomain
230+
.br
231+
Create a Wordpress Multisite with Sub Domains Setup.
232+
.br
233+
.TP
234+
.B --db
235+
.br
236+
Delete website database.
237+
.br
238+
.TP
239+
.B --files
240+
.br
241+
Delete website webroot.
242+
.br
243+
.TP
244+
.B --no-prompt
245+
.br
246+
Does not prompt for confirmation when delete command used.
247+
.TP
248+
.B --auth
249+
.br
250+
used with ee secure command. Update credential of HTTP authentication
251+
.TP
252+
.B --port
253+
.br
254+
used with ee secure command. Change EasyEngine admin port 22222.
255+
.TP
256+
.B --ip
257+
.br
258+
used with ee secure command. Update whitelist IP address
259+
.SH WORDPRESS CACHING OPTIONS
260+
.TP
261+
.B --basic
262+
.br
263+
Create WordPress website without cache.
264+
.TP
265+
.B --w3tc
266+
.br
267+
Install and activate Nginx-helper and W3 Total Cache plugin.
268+
.TP
269+
.B --wpsc
270+
.br
271+
Install and activate Nginx-helper and WP Super Cache plugin.
272+
.TP
273+
.B --wpfc
274+
.br
275+
Install and activate Nginx-helper and W3 Total Cache plugin with
276+
.br
277+
Nginx FastCGI cache.
278+
.SH FILES
279+
.br
280+
/etc/easyengine/ee.conf
281+
.SH BUGS
282+
Report bugs at <http://github.com/rtCamp/easyengine/issues/>
283+
.SH AUTHOR
284+
.br
285+
.B rtCamp Team
286+
.I \<[email protected]\>
287+
.br
288+
.B Mitesh Shah
289+
.I \<[email protected]\>
290+
.br
291+
.B Manish
292+
.I \<[email protected]\>
293+
.br
294+
.B Gaurav
295+
.I \<[email protected]\>
296+
.br
297+
.B Harshad
298+
.I \<[email protected]>
299+
.br
300+
.B Shital
301+
.I \<[email protected]\>
302+
.br
303+
.SH "SEE ALSO"
304+
.br
305+
EE:
306+
.I https://rtcamp.com/easyengine/
307+
.br
308+
FAQ:
309+
.I https://rtcamp.com/easyengine/faq/
310+
.br
311+
DOCS:
312+
.I https://rtcamp.com/easyengine/docs/

‎ee/cli/plugins/info.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
from pynginxconfig import NginxConfig
66
from ee.core.aptget import EEAptGet
77
from ee.core.shellexec import EEShellExec
8+
from ee.core.logging import Log
89
import os
910
import configparser
1011

@@ -180,13 +181,13 @@ def default(self):
180181
if EEAptGet.is_installed(self, 'php5-fpm'):
181182
self.info_php()
182183
else:
183-
Log.error("PHP5 is not installed")
184+
Log.error(self, "PHP5 is not installed")
184185

185186
if self.app.pargs.mysql:
186187
if EEShellExec.cmd_exec(self, "mysqladmin ping"):
187188
self.info_mysql()
188189
else:
189-
Log.error("MySQL is not installed")
190+
Log.error(self, "MySQL is not installed")
190191

191192

192193
def load(app):

‎setup.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@
7777
('/etc/ee/plugins.d', conf),
7878
('/usr/lib/ee/templates', templates),
7979
('/etc/bash_completion.d/',
80-
['config/bash_completion.d/ee_auto.rc'])],
80+
['config/bash_completion.d/ee_auto.rc']),
81+
('/usr/share/man/man8/', ['docs/ee.8'])],
8182
setup_requires=[],
8283
entry_points="""
8384
[console_scripts]

0 commit comments

Comments
 (0)