v0.1 basic access to config

* read/write nginx config files * add, remove, update, enable and disable site configurations

Author: David Schenk

Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.7-alpine
+
+ADD requirements.txt .
+
+RUN apk add python3-dev build-base linux-headers pcre-dev && pip install --no-cache-dir -r requirements.txt
+
+# adding application files
+ADD . /webapp
+
+# configure path /webapp to HOME-dir
+ENV HOME /webapp
+WORKDIR /webapp
+
+ENTRYPOINT ["uwsgi"]
+CMD ["--http", "0.0.0.0:8080", "--wsgi-file", "wsgi.py", "--callable", "app", "--processes", "1", "--threads", "8"]

README.md

@@ -1,5 +1,30 @@
 # nginx ui
 
-We use nginx in our company lab environment. 
-I thought it would be nice to have the possibility to view and adjust 
-the configuration of nginx via web ui.
+We use nginx in our company lab environment. It often happens that my 
+colleagues have developed an application that is now deployed in our Stage 
+or Prod environment. To make this application accessible nginx has to be 
+adapted. Most of the time my colleagues don't have the permission to access 
+the server and change the configuration files and since I don't feel like 
+doing this for everyone anymore I thought a UI could help us all. If you 
+feel the same way I wish you a lot of fun with the application and I am 
+looking forward to your feedback, change requests or even a star.
+
+## setup
+
+Containerization is now state of the art and therefore the application is 
+delivered in a container.
+
+### docker
+
+Repository @ [DockerHub](https://hub.docker.com/r/schenkd/nginx-ui)
+
+```yaml
+services:
+ nginx-ui:
+ image: nginx-ui:latest
+ ports:
+ - 8080:8080
+ volumes:
+ - nginx:/etc/nginx
+```
+

app/__init__.py

@@ -1,11 +1,17 @@
 from flask import Flask
 from config import config
+from flask_moment import Moment
+
+
+moment = Moment()
 
 
 def create_app(config_name):
  app = Flask(__name__)
  app.config.from_object(config[config_name])
+
  config[config_name].init_app(app)
+ moment.init_app(app)
 
  from app.ui import ui as ui_blueprint
  app.register_blueprint(ui_blueprint)

app/api/endpoints.py

@@ -0,0 +1,145 @@
+import datetime
+import io
+import os
+
+import flask
+
+from app.api import api
+
+
+@api.route('/config/<name>', methods=['GET'])
+def get_config(name):
+ nginx_path = flask.current_app.config['NGINX_PATH']
+
+ with io.open(os.path.join(nginx_path, name), 'r') as f:
+ _file = f.read()
+
+ return flask.render_template('config.html', name=name, file=_file)
+
+
+@api.route('/config/<name>', methods=['POST'])
+def post_config(name):
+ content = flask.request.get_json()
+ nginx_path = flask.current_app.config['NGINX_PATH']
+
+ with io.open(os.path.join(nginx_path, name), 'w') as f:
+ f.write(content['file'])
+
+ return flask.make_response({'success': True}), 200
+
+
+@api.route('/domains', methods=['GET'])
+def get_domains():
+ config_path = flask.current_app.config['CONFIG_PATH']
+ sites_available = []
+ sites_enabled = []
+
+ for _ in os.listdir(config_path):
+
+ if os.path.isfile(os.path.join(config_path, _)):
+ domain, state = _.rsplit('.', 1)
+
+ if state == 'conf':
+ time = datetime.datetime.fromtimestamp(os.path.getmtime(os.path.join(config_path, _)))
+
+ sites_available.append({
+ 'name': domain,
+ 'time': time
+ })
+ sites_enabled.append(domain)
+ elif state == 'disabled':
+ time = datetime.datetime.fromtimestamp(os.path.getmtime(os.path.join(config_path, _)))
+
+ sites_available.append({
+ 'name': domain.rsplit('.', 1)[0],
+ 'time': time
+ })
+
+ return flask.render_template('domains.html', sites_available=sites_available, sites_enabled=sites_enabled)
+
+
+@api.route('/domain/<name>', methods=['GET'])
+def get_domain(name):
+ config_path = flask.current_app.config['CONFIG_PATH']
+ _file = ''
+ enabled = True
+
+ for _ in os.listdir(config_path):
+
+ if os.path.isfile(os.path.join(config_path, _)):
+ if _.startswith(name):
+ domain, state = _.rsplit('.', 1)
+
+ if state == 'disabled':
+ enabled = False
+
+ with io.open(os.path.join(config_path, _), 'r') as f:
+ _file = f.read()
+
+ break
+
+ return flask.render_template('domain.html', name=name, file=_file, enabled=enabled)
+
+
+@api.route('/domain/<name>', methods=['POST'])
+def post_domain(name):
+ config_path = flask.current_app.config['CONFIG_PATH']
+ new_domain = flask.render_template('new_domain.j2', name=name)
+ name = name + '.conf.disabled'
+
+ with io.open(os.path.join(config_path, name), 'w') as f:
+ f.write(new_domain)
+
+ return flask.jsonify({'success': True}), 201
+
+
+@api.route('/domain/<name>', methods=['DELETE'])
+def delete_domain(name):
+ config_path = flask.current_app.config['CONFIG_PATH']
+ removed = False
+
+ for _ in os.listdir(config_path):
+
+ if os.path.isfile(os.path.join(config_path, _)):
+ if _.startswith(name):
+ os.remove(os.path.join(config_path, _))
+ removed = not os.path.exists(os.path.join(config_path, _))
+ break
+
+ if removed:
+ return flask.jsonify({'success': True}), 200
+ else:
+ return flask.jsonify({'success': False}), 400
+
+
+@api.route('/domain/<name>', methods=['PUT'])
+def put_domain(name):
+ content = flask.request.get_json()
+ config_path = flask.current_app.config['CONFIG_PATH']
+
+ for _ in os.listdir(config_path):
+
+ if os.path.isfile(os.path.join(config_path, _)):
+ if _.startswith(name):
+ with io.open(os.path.join(config_path, _), 'w') as f:
+ f.write(content['file'])
+
+ return flask.make_response({'success': True}), 200
+
+
+@api.route('/domain/<name>/enable', methods=['POST'])
+def enable_domain(name):
+ content = flask.request.get_json()
+ config_path = flask.current_app.config['CONFIG_PATH']
+
+ for _ in os.listdir(config_path):
+
+ if os.path.isfile(os.path.join(config_path, _)):
+ if _.startswith(name):
+ if content['enable']:
+ new_filename, disable = _.rsplit('.', 1)
+ os.rename(os.path.join(config_path, _), os.path.join(config_path, new_filename))
+ else:
+ os.rename(os.path.join(config_path, _), os.path.join(config_path, _ + '.disabled'))
+
+ return flask.make_response({'success': True}), 200

app/static/custom.css

@@ -0,0 +1,16 @@
+@import url('https://fonts.googleapis.com/css?family=Source+Code+Pro');
+
+textarea {
+ margin: 0;
+ border-radius: 0;
+}
+
+.code {
+ font-size: 17px;
+ font-weight: 200;
+ font-family: 'Source Code Pro', monospace;
+}
+
+#main-container {
+ margin-top: 5em;
+}