├── .gitignore
├── CHANGELOG.md
├── MANIFEST.in
├── README.md
├── nginx_sites
    ├── __init__.py
    ├── colorize.py
    ├── nginx_sites.py
    └── templates
    │   ├── apache.conf
    │   ├── laravel-php5.conf
    │   ├── laravel-php7.conf
    │   ├── node.conf
    │   ├── php.conf
    │   ├── python.conf
    │   └── static.conf
└── setup.py


/.gitignore:
--------------------------------------------------------------------------------
1 | *.pyc
2 | .*swp
3 | dist
4 | build
5 | .ropeproject
6 | *.egg-info/
7 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | ## 0.1.4
 2 | 
 3 | * auto sudo on permission denied
 4 | * add `templates`, `templates-show`
 5 | 
 6 | ## 0.1.3
 7 | 
 8 | * add template for laravel by @joaosalless
 9 | 
10 | ## 0.1.2
11 | 
12 | * add `static` template
13 | * add `reconfig`
14 | 
15 | ## 0.1.1
16 | 
17 | * no longer needs blessing
18 | * `--path` renamed to `--root`
19 | 


--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include nginx_sites/templates/*.conf
2 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # nginx-sites
 2 | 
 3 | cli utility for managing nginx vhost configs
 4 | 
 5 | install using pip
 6 | ```sh
 7 | pip install nginx-sites
 8 | ```
 9 | 
10 | ## usage
11 | 
12 | ```sh
13 | ngx ls
14 | ngx enable <name>
15 | ngx disable <name>
16 | ngx new <name> [--path=<path>] [--template=<template>] [(--port=<port>)...]
17 | ngx rm <name>
18 | ngx open <name>
19 | ngx cp <source> <target>
20 | ngx --version
21 | ```
22 | 
23 | examples
24 | 
25 | ```
26 | ngx new nodejs.test --template=node --port=3003 --port=3004
27 | ngx new phpfpm.test --template=php --port=9000
28 | service nginx reload
29 | ```
30 | 
31 | ## adding new vhost templates
32 | 
33 | Copy the directory `/usr/local/lib/python2.7/dist-packages/nginx_sites/templates` to `~/.nginx-sites-templates`
34 | 
35 | Edit the configuration file `~/.nginx-sites.json` and set it according to the settings below:
36 | 
37 | ```json
38 | {
39 |     "templates_path": "/home/username/.nginx-sites-templates",
40 |     "sites_available": "/etc/nginx/sites-available",
41 |     "nginx_bin": "/usr/sbin/nginx",
42 |     "sites_enabled": "/etc/nginx/sites-enabled"
43 | }
44 | ```
45 | 
46 | Create your templates in `~/.nginx-sites-templates`
47 | 
48 | After setting up your new template, it is available for use with the command:
49 | 
50 | ```sh
51 | ngx new myapp.dev --template=mytemplate
52 | ngx reload
53 | ```
54 | 


--------------------------------------------------------------------------------
/nginx_sites/__init__.py:
--------------------------------------------------------------------------------
1 | from .nginx_sites import main
2 | __all__ = ['main']
3 | 


--------------------------------------------------------------------------------
/nginx_sites/colorize.py:
--------------------------------------------------------------------------------
 1 | color_map = {
 2 |     'black': 0,
 3 |     'red': 1,
 4 |     'green': 2,
 5 |     'yellow': 3,
 6 |     'blue': 4,
 7 |     'magenta': 5,
 8 |     'cyan': 6,
 9 |     'white': 7,
10 | }
11 | 
12 | csi = '\x1b['
13 | reset = '\x1b[0m'
14 | 
15 | 
16 | def formatter(fg, bg=None, bold=False):
17 |     params = []
18 |     if bg in color_map:
19 |         params.append(str(color_map[bg] + 40))
20 |     if fg in color_map:
21 |         params.append(str(color_map[fg] + 30))
22 |     if bold:
23 |         params.append('1')
24 | 
25 |     def format(message):
26 |         if params:
27 |             message = ''.join((csi, ';'.join(params),
28 |                                'm', message, reset))
29 |         return message
30 | 
31 |     return format
32 | 


--------------------------------------------------------------------------------
/nginx_sites/nginx_sites.py:
--------------------------------------------------------------------------------
  1 | """nginx sites
  2 | 
  3 | Usage:
  4 |   ngx ls
  5 |   ngx enable <name>
  6 |   ngx disable <name>
  7 |   ngx new <name> [--root=<path>] [--template=<template>] [(--port=<port>)...]
  8 |   ngx rm <name>
  9 |   ngx open <name>
 10 |   ngx cp <source> <target>
 11 |   ngx reload
 12 |   ngx config [-e]
 13 |   ngx reconfig
 14 |   ngx templates
 15 |   ngx templates-show <name>
 16 |   ngx --version
 17 |   ngx -h
 18 | 
 19 | Options:
 20 |   -h --help              Show this screen.
 21 |   --version              Show version.
 22 |   --template=<template>  specify a template [default: static].
 23 |   --root=<path>          specify root default is pwd.
 24 | 
 25 | Examples:
 26 |     ngx new static.test --root /var/www/static
 27 |     ngx new nodejs.test --template=node --port=3003 --port=3004
 28 |     ngx new phpfpm.test --template=php --port=9000
 29 | """
 30 | 
 31 | import os
 32 | import sys
 33 | import time
 34 | import tempfile
 35 | import readline
 36 | import json
 37 | from subprocess import call
 38 | from subprocess import check_output
 39 | import pkg_resources
 40 | import shutil
 41 | from docopt import docopt
 42 | from pystache import render
 43 | 
 44 | from .colorize import formatter
 45 | 
 46 | config_path = '~/.nginx-sites.json'
 47 | 
 48 | 
 49 | class NginxSites:
 50 |     def __init__(self, config):
 51 |         self.config = config
 52 | 
 53 |     def enabled_conf(self, name=None):
 54 |         if name is None:
 55 |             return self.config['sites_enabled']
 56 |         return os.path.join(self.config['sites_enabled'], name)
 57 | 
 58 |     def available_conf(self, name=None):
 59 |         if name is None:
 60 |             return self.config['sites_available']
 61 |         return os.path.join(self.config['sites_available'], name)
 62 | 
 63 |     def new(self, server_name, root, template, port):
 64 |         if port is not None:
 65 |             port = [{'port': p} for p in port]
 66 |         with open(self.available_conf(server_name), 'w') as fp:
 67 |             template_path = os.path.join(self.config['templates_path'],
 68 |                                          template + '.conf')
 69 |             with open(template_path, 'r') as tmpl:
 70 |                 fp.write(render(tmpl.read(), locals()))
 71 |                 self.enable(server_name)
 72 | 
 73 |     def rm(self, name):
 74 |         self.disable(name)
 75 |         if os.path.exists(self.available_conf(name)):
 76 |             os.remove(self.available_conf(name))
 77 | 
 78 |     def ls(self):
 79 |         walker = os.walk(self.enabled_conf())
 80 |         _, _, enabled_sites = next(walker)
 81 |         walker = os.walk(self.available_conf())
 82 |         _, _, available_sites = next(walker)
 83 |         print(formatter('green')('enabled sites:'))
 84 |         sys.stdout.writelines(['  %s\n' % site for site in enabled_sites
 85 |                                if site in available_sites])
 86 |         print(formatter('yellow')('available sites:'))
 87 |         sys.stdout.writelines(['  %s\n' % site for site in available_sites
 88 |                                if site not in enabled_sites])
 89 |         print(formatter('red')('active sites:'))
 90 |         sys.stdout.writelines(['  %s\n' % site for site in enabled_sites
 91 |                                if site not in available_sites])
 92 | 
 93 |     def enable(self, name):
 94 |         if os.path.exists(self.enabled_conf(name)):
 95 |             os.remove(self.enabled_conf(name))
 96 |         os.symlink(self.available_conf(name), self.enabled_conf(name))
 97 | 
 98 |     def disable(self, name):
 99 |         if os.path.exists(self.enabled_conf(name)):
100 |             os.remove(self.enabled_conf(name))
101 | 
102 |     def cp(self, source, target):
103 |         if os.path.exists(self.available_conf(source)):
104 |             shutil.copy2(self.available_conf(source),
105 |                          self.available_conf(target))
106 |             self.open(target)
107 |         else:
108 |             print("%s not exists" % self.available_conf(source))
109 | 
110 |     def open(self, name):
111 |         editor = os.environ.get('EDITOR', 'vi')
112 |         call([editor, self.available_conf(name)])
113 | 
114 |     def reload(self):
115 |         call(["sudo", self.config['nginx_bin'], '-s', 'reload'])
116 | 
117 |     def templates_list(self):
118 |         walker = os.walk(self.config['templates_path'])
119 |         _, _, templates = next(walker)
120 |         sys.stdout.writelines(['%s\n' % t.replace(".conf", '')
121 |                                for t in templates])
122 | 
123 |     def templates_show(self, name):
124 |         template_path = os.path.join(self.config['templates_path'],
125 |                                      name + '.conf')
126 |         if os.path.exists(template_path):
127 |             with open(template_path, 'r') as tmpl:
128 |                 sys.stdout.write(tmpl.read())
129 |         else:
130 |             print(formatter('red')("template %s not found in %s"
131 |                                    % (name, template_path)))
132 |             sys.exit(1)
133 | 
134 | 
135 | def editconf(path):
136 |     editor = os.environ.get('EDITOR', 'vi')
137 |     f = tempfile.NamedTemporaryFile(delete=False)
138 |     f.close()
139 |     if(os.path.exists(path)):
140 |         shutil.copyfile(path, f.name)
141 |     ret = call([editor, f.name])
142 |     if ret is 0:
143 |         try:
144 |             with open(f.name) as fp:
145 |                 json.load(fp)
146 |             shutil.copyfile(f.name, path)
147 |         except ValueError:
148 |             print('not valid json')
149 |         except:
150 |             print('config failed!')
151 | 
152 | 
153 | def load_config(path):
154 |     if os.path.exists(path):
155 |         try:
156 |             with open(path) as fp:
157 |                 return json.load(fp)
158 |         except ValueError:
159 |             print('config file is not valid json')
160 |             time.sleep(2)
161 |             editconf(path)
162 |             return load_config(path)
163 |         except:
164 |             print('failed to load config from %s' % path)
165 | 
166 | 
167 | def dump_config(path, config):
168 |     with open(path, 'w') as fp:
169 |         json.dump(config, fp, indent=True)
170 | 
171 | 
172 | def get_input(prompt, prefill=''):
173 |     readline.set_startup_hook(lambda: readline.insert_text(prefill))
174 |     try:
175 |         return raw_input(prompt)
176 |     finally:
177 |         readline.set_startup_hook()
178 | 
179 | 
180 | def config_interactively():
181 |     ret = {}
182 |     ret['sites_enabled'] = get_input('path to sites-enabled: ',
183 |                                      '/etc/nginx/sites-enabled')
184 |     ret['sites_available'] = get_input(
185 |         'path to sites-available: ',
186 |         ret['sites_enabled'].replace('enabled', 'available'))
187 |     try:
188 |         nginx_bin = check_output(['which', 'nginx']).strip()
189 |     except:
190 |         nginx_bin = ''
191 |     ret['nginx_bin'] = get_input('path to nginx executable: ', nginx_bin)
192 |     dist = pkg_resources.get_distribution('nginx_sites')
193 |     ret['templates_path'] = os.path.join(dist.location,
194 |                                          'nginx_sites', 'templates')
195 |     return ret
196 | 
197 | 
198 | def run():
199 |     config_path_full = os.path.expanduser(config_path)
200 |     config = load_config(config_path_full)
201 | 
202 |     if config is None:
203 |         print('config file not loaded!')
204 |         config = config_interactively()
205 |         dump_config(config_path_full, config)
206 | 
207 |     args = docopt(__doc__, version='nginx-sites 0.1.6')
208 |     sites = NginxSites(config)
209 |     if args['ls']:
210 |         sites.ls()
211 |     elif args['enable']:
212 |         sites.enable(args['<name>'])
213 |     elif args['disable']:
214 |         sites.disable(args['<name>'])
215 |     elif args['new']:
216 |         root = args['--root'] or os.getcwd()
217 |         sites.new(args['<name>'], root, args['--template'], args['--port'])
218 |     elif args['rm']:
219 |         sites.rm(args['<name>'])
220 |     elif args['cp']:
221 |         sites.cp(args['<source>'], args['<target>'])
222 |     elif args['open']:
223 |         sites.open(args['<name>'])
224 |     elif args['config']:
225 |         if args['-e']:
226 |             editconf(config_path_full)
227 |         else:
228 |             print(json.dumps(load_config(config_path_full), indent=2))
229 |     elif args['reconfig']:
230 |         config = config_interactively()
231 |         dump_config(config_path_full, config)
232 |     elif args['reload']:
233 |         sites.reload()
234 |     elif args['templates']:
235 |         sites.templates_list()
236 |     elif args['templates-show']:
237 |         sites.templates_show(args['<name>'])
238 | 
239 | 
240 | def main():
241 |     try:
242 |         run()
243 |     except (IOError, OSError) as err:
244 |         if err.errno is 13:
245 |             os.execvp("sudo", ["sudo"] + sys.argv)
246 |         else:
247 |             print(err.strerror)
248 |             sys.exit(1)
249 | 
250 | 
251 | if __name__ == '__main__':
252 |     main()
253 | 


--------------------------------------------------------------------------------
/nginx_sites/templates/apache.conf:
--------------------------------------------------------------------------------
 1 | <VirtualHost *:80>
 2 |     ServerName {{server_name}}
 3 | 
 4 |     DocumentRoot "{{root}}/"
 5 | 
 6 |     <Directory "{{root}}/">
 7 |         Options FollowSymLinks MultiViews Includes
 8 |         AllowOverride All
 9 |         Order allow,deny
10 |         Allow from all
11 |     </Directory>
12 | 
13 |     ErrorLog /var/log/apache2/{{server_name}}_error.log
14 |     LogLevel warn
15 |     CustomLog /var/log/apache2/{{server_name}}_access.log combined
16 | </VirtualHost>
17 | 


--------------------------------------------------------------------------------
/nginx_sites/templates/laravel-php5.conf:
--------------------------------------------------------------------------------
 1 | server {
 2 |     listen 80;
 3 |     listen localhost:80;
 4 |     
 5 |     server_name {{server_name}};
 6 |     root "{{root}}";
 7 | 
 8 |     index index.html index.htm index.php;
 9 |  
10 |     charset utf-8;
11 |  
12 |     location / {
13 |         try_files $uri $uri/ /index.php?$query_string;
14 |     }
15 |  
16 |     location = /favicon.ico { access_log off; log_not_found off; }
17 |     location = /robots.txt  { access_log off; log_not_found off; }
18 |  
19 |     access_log off;
20 |     error_log  /var/log/nginx/{{server_name}}-error.log error;
21 |  
22 |     error_page 404 /index.php;
23 |  
24 |     location ~ \.php$ {
25 |         fastcgi_split_path_info ^(.+\.php)(/.+)$;
26 |         fastcgi_pass unix:/var/run/php5-fpm.sock;
27 |         fastcgi_index index.php;
28 |         include fastcgi_params;
29 |         fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
30 |         fastcgi_intercept_errors on;
31 |         fastcgi_buffer_size 16k;
32 |         fastcgi_buffers 4 16k;
33 |     }
34 |  
35 |     location ~ /\.ht {
36 |         deny all;
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/nginx_sites/templates/laravel-php7.conf:
--------------------------------------------------------------------------------
 1 | server {
 2 |     listen 80;
 3 |     listen localhost:80;
 4 |     
 5 |     server_name {{server_name}};
 6 |     root "{{root}}";
 7 | 
 8 |     index index.html index.htm index.php;
 9 |  
10 |     charset utf-8;
11 |  
12 |     location / {
13 |         try_files $uri $uri/ /index.php?$query_string;
14 |     }
15 |  
16 |     location = /favicon.ico { access_log off; log_not_found off; }
17 |     location = /robots.txt  { access_log off; log_not_found off; }
18 |  
19 |     access_log off;
20 |     error_log  /var/log/nginx/{{server_name}}-error.log error;
21 |  
22 |     error_page 404 /index.php;
23 |  
24 |     location ~ \.php$ {
25 |         fastcgi_split_path_info ^(.+\.php)(/.+)$;
26 |         fastcgi_pass unix:/var/run/php/php7.0-fpm.sock;
27 |         fastcgi_index index.php;
28 |         include fastcgi_params;
29 |         fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
30 |         fastcgi_intercept_errors on;
31 |         fastcgi_buffer_size 16k;
32 |         fastcgi_buffers 4 16k;
33 |     }
34 |  
35 |     location ~ /\.ht {
36 |         deny all;
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/nginx_sites/templates/node.conf:
--------------------------------------------------------------------------------
 1 | upstream {{server_name}}.node.upstream {
 2 |     {{#port}}
 3 |     server 127.0.0.1:{{port}};
 4 |     {{/port}}
 5 | }
 6 | 
 7 | server {
 8 |     listen 80;
 9 |     server_name {{server_name}};
10 |     keepalive_timeout 0;
11 |     access_log /var/log/nginx/{{server_name}}.access.log;
12 |     location / {
13 |         proxy_http_version 1.1;
14 |         proxy_redirect off;
15 |         proxy_set_header X-Real-IP $remote_addr;
16 |         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
17 |         proxy_set_header Host $http_host;
18 |         proxy_set_header X-NginX-Proxy true;
19 |         proxy_pass http://{{server_name}}.node.upstream;
20 |         gzip on;
21 |         gzip_types text/html text/css application/json application/javascript;
22 |     }
23 | }
24 | 
25 | # vim: set ft=nginx:
26 | 


--------------------------------------------------------------------------------
/nginx_sites/templates/php.conf:
--------------------------------------------------------------------------------
 1 | server {
 2 |     listen 80;
 3 |     server_name {{server_name}};
 4 |     root {{root}};
 5 |     index index.php index.html;
 6 |     location / {
 7 |         if (!-e $request_filename) {
 8 |             rewrite ^/(.*)$ /index.php?$1 last;
 9 |         }
10 |     }
11 |     location ~ \.php$ {
12 |         try_files $uri =404;
13 |         {{#port}}
14 |         fastcgi_pass   127.0.0.1:{{port}};
15 |         {{/port}}
16 |         fastcgi_index  index.php;
17 |         fastcgi_param  SCRIPT_FILENAME {{root}}$fastcgi_script_name;
18 |         include        fastcgi_params;
19 |     }
20 | }
21 | 
22 | # vim: set ft=nginx:
23 | 


--------------------------------------------------------------------------------
/nginx_sites/templates/python.conf:
--------------------------------------------------------------------------------
 1 | server {
 2 |     listen 80;
 3 |     server_name {{server_name}};
 4 |     root {{root}};
 5 |     location /public/ {
 6 |         alias {{root}}/public/;
 7 |         expires 30d;
 8 |         access_log off;
 9 |     }
10 |     location / {
11 |         include uwsgi_params;
12 |         uwsgi_pass unix:/var/run/{{server_name}}.sock;
13 |     }
14 | }
15 | 
16 | # vim: set ft=nginx:
17 | 


--------------------------------------------------------------------------------
/nginx_sites/templates/static.conf:
--------------------------------------------------------------------------------
1 | server {
2 |     listen 80;
3 |     server_name {{server_name}};
4 |     root {{root}};
5 |     index index.html;
6 | }
7 | 
8 | # vim: set ft=nginx:


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | from setuptools import setup
 2 | 
 3 | setup(
 4 |     name='nginx-sites',
 5 |     url='https://github.com/zweifisch/nginx-sites',
 6 |     version='0.1.6',
 7 |     description='cli utility for managing nginx site configs',
 8 |     author='Feng Zhou',
 9 |     author_email='zf.pascal@gmail.com',
10 |     packages=['nginx_sites'],
11 |     package_data={'nginx_sites': ['templates/*.conf']},
12 |     install_requires=['docopt', 'pystache'],
13 |     entry_points={
14 |         'console_scripts': ['nginx-sites=nginx_sites:main',
15 |                             'ngx=nginx_sites:main'],
16 |     },
17 | )
18 | 


--------------------------------------------------------------------------------