cleanup

.gitignore

@@ -7,6 +7,7 @@ devel.sh
 *.egg*
 .coverage
 .coveragerc
+.pylintrc
 dist
 _build
 .tags

.gitlab-ci.yml

@@ -21,7 +21,7 @@ test:py2.7:
   stage: test
   image: ziirish/python:2.7
   script:
-  - /bin/bash test/run_tests.sh
+  - /bin/bash tests/run_tests.sh
   tags:
   - docker
   except:
@@ -31,7 +31,7 @@ test:py3.4:
   stage: test
   image: ziirish/python:3.4
   script:
-  - /bin/bash test/run_tests.sh
+  - /bin/bash tests/run_tests.sh
   tags:
   - docker
   except:
@@ -40,7 +40,7 @@ test:py3.4:
 build:py2:
   stage: build
   script:
-  - /bin/bash test/run_build.sh
+  - /bin/bash tests/run_build.sh
   tags:
   - build
   only:
@@ -51,12 +51,26 @@ build:py2:
     - dist/
     - meta/
 
+build:py3:
+  stage: build
+  image: ziirish/python:3.4
+  script:
+  - /bin/bash tests/run_build.sh
+  tags:
+  - build
+  only:
+  - master
+  artifacts:
+    paths:
+    - dist/
+    - meta/
+
 build:docker:latest:
   stage: build
   script:
   - docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN $CI_REGISTRY
-  - docker build -t $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:latest .
-  - docker build -t $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:latest-py3.6 -f Dockerfile-py3.6 .
+  - docker build -t $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:latest -f docker/Dockerfile .
+  - docker build -t $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:latest-py3.6 -f docker/Dockerfile-py3.6 .
   - docker push $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:latest
   - docker push $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:latest-py3.6
   tags:
@@ -68,8 +82,8 @@ build:docker:release:
   stage: build
   script:
   - docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN $CI_REGISTRY
-  - docker build -t $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:$CI_BUILD_TAG .
-  - docker build -t $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:$CI_BUILD_TAG-py3.6 -f Dockerfile-py3.6 .
+  - docker build -t $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:$CI_BUILD_TAG -f docker/Dockerfile .
+  - docker build -t $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:$CI_BUILD_TAG-py3.6 -f docker/Dockerfile-py3.6 .
   - docker push $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:$CI_BUILD_TAG
   - docker push $CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME:$CI_BUILD_TAG-py3.6
   only:
@@ -77,28 +91,14 @@ build:docker:release:
   tags:
   - registry
 
-build:py3:
-  stage: build
-  image: ziirish/python:3.4
-  script:
-  - /bin/bash test/run_build.sh
-  tags:
-  - build
-  only:
-  - master
-  artifacts:
-    paths:
-    - dist/
-    - meta/
-
 deploy:demo:
   stage: deploy
   script:
-  - find docker/ -name "install" | xargs sed -i "s/@build@/$(git rev-parse HEAD)/"
-  - cd docker && find . -maxdepth 1 -type d -a ! -name dist -exec cp -r ../dist "{}/" \; -exec cp -r ../meta "{}/" \; && cd ..
-  - find docker/ -name "Dockerfile" | xargs sed -i "s,^.*@ARTIFACTS@.*$,COPY dist/*.tar.gz /tmp/burpui.dev.tar.gz,;s,^.*@BUIAGENT_ARTIFACTS@.*$,COPY meta/burp-ui-agent*.tar.gz /tmp/burp-ui-agent.dev.tar.gz,"
+  - find docker/demo/ -name "install" | xargs sed -i "s/@build@/$(git rev-parse HEAD)/"
+  - cd docker/demo/ && find . -maxdepth 1 -type d -a ! -name dist -exec cp -r ../../dist "{}/" \; -exec cp -r ../../meta "{}/" \; && cd ../..
+  - find docker/demo/ -name "Dockerfile" | xargs sed -i "s,^.*@ARTIFACTS@.*$,COPY dist/*.tar.gz /tmp/burpui.dev.tar.gz,;s,^.*@BUIAGENT_ARTIFACTS@.*$,COPY meta/burp-ui-agent*.tar.gz /tmp/burp-ui-agent.dev.tar.gz,"
   - test -d /srv/demo/docker && rm -rf /srv/demo/docker
-  - cp -r docker/ /srv/demo/
+  - cp -r docker/demo/ /srv/demo/
   - cd /srv/demo/docker/
   - docker-compose build
   - docker-compose stop
@@ -107,5 +107,4 @@ deploy:demo:
   tags:
   - deploy
   only:
-  - rc
   - demo

.pylintrc

@@ -1,378 +0,0 @@
-[MASTER]
-
-# Specify a configuration file.
-#rcfile=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Add files or directories to the blacklist. They should be base names, not
-# paths.
-ignore=CVS
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-# Use multiple processes to speed up Pylint.
-jobs=1
-
-# Allow loading of arbitrary C extensions. Extensions are imported into the
-# active Python interpreter and may run arbitrary code.
-unsafe-load-any-extension=no
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code
-extension-pkg-whitelist=
-
-# Allow optimization of some AST trees. This will activate a peephole AST
-# optimizer, which will apply various small optimizations. For instance, it can
-# be used to obtain the result of joining multiple strings with the addition
-# operator. Joining a lot of strings can lead to a maximum recursion error in
-# Pylint and this flag can prevent that. It has one side effect, the resulting
-# AST will be different than the one from reality.
-optimize-ast=no
-
-
-[MESSAGES CONTROL]
-
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
-confidence=
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time. See also the "--disable" option for examples.
-#enable=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once).You can also use "--disable=all" to
-# disable everything first and then reenable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use"--disable=all --enable=classes
-# --disable=W"
-disable=import-star-module-level,old-octal-literal,oct-method,print-statement,unpacking-in-except,parameter-unpacking,backtick,old-raise-syntax,old-ne-operator,long-suffix,dict-view-method,dict-iter-method,metaclass-assignment,next-method-called,raising-string,indexing-exception,raw_input-builtin,long-builtin,file-builtin,execfile-builtin,coerce-builtin,cmp-builtin,buffer-builtin,basestring-builtin,apply-builtin,filter-builtin-not-iterating,line-too-long,using-cmp-argument,useless-suppression,range-builtin-not-iterating,suppressed-message,no-absolute-import,old-division,cmp-method,reload-builtin,zip-builtin-not-iterating,intern-builtin,unichr-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,input-builtin,round-builtin,hex-method,nonzero-method,map-builtin-not-iterating
-
-
-[REPORTS]
-
-# Set the output format. Available formats are text, parseable, colorized, msvs
-# (visual studio) and html. You can also give a reporter class, eg
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Put messages in a separate file for each module / package specified on the
-# command line instead of printing them on stdout. Reports (if any) will be
-# written in a file name "pylint_global.[txt|html]".
-files-output=no
-
-# Tells whether to display a full report or only the messages
-reports=yes
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details
-#msg-template=
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
-
-
-[SPELLING]
-
-# Spelling dictionary name. Available dictionaries: none. To make it working
-# install python-enchant package.
-spelling-dict=
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to indicated private dictionary in
-# --spelling-private-dict-file option instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[TYPECHECK]
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis. It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=
-
-# List of classes names for which member attributes should not be checked
-# (useful for classes with attributes dynamically set). This supports can work
-# with qualified names.
-ignored-classes=
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-
-[FORMAT]
-
-# Maximum number of characters on a single line.
-max-line-length=100
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,dict-separator
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-# Number of spaces of indent required inside a hanging  or continued line.
-indent-after-paren=4
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-expected-line-ending-format=
-
-
-[SIMILARITIES]
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=no
-
-
-[LOGGING]
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format
-logging-modules=logging
-
-
-[VARIABLES]
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# A regular expression matching the name of dummy variables (i.e. expectedly
-# not used).
-dummy-variables-rgx=_$|dummy
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,_cb
-
-
-[BASIC]
-
-# List of builtins function names that should not be used, separated by a comma
-bad-functions=map,filter,input
-
-# Good variable names which should always be accepted, separated by a comma
-good-names=i,j,k,ex,Run,_
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
-
-# Include a hint for the correct naming format with invalid-name
-include-naming-hint=no
-
-# Regular expression matching correct function names
-function-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Naming hint for function names
-function-name-hint=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression matching correct variable names
-variable-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Naming hint for variable names
-variable-name-hint=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression matching correct constant names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Naming hint for constant names
-const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Regular expression matching correct attribute names
-attr-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Naming hint for attribute names
-attr-name-hint=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression matching correct argument names
-argument-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Naming hint for argument names
-argument-name-hint=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression matching correct class attribute names
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Naming hint for class attribute names
-class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Regular expression matching correct inline iteration names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Naming hint for inline iteration names
-inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
-
-# Regular expression matching correct class names
-class-rgx=[A-Z_][a-zA-Z0-9]+$
-
-# Naming hint for class names
-class-name-hint=[A-Z_][a-zA-Z0-9]+$
-
-# Regular expression matching correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Naming hint for module names
-module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Regular expression matching correct method names
-method-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Naming hint for method names
-method-name-hint=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-
-[ELIF]
-
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
-
-
-[IMPORTS]
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=regsub,TERMIOS,Bastion,rexec
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-
-[CLASSES]
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
-
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,_fields,_replace,_source,_make
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of branch for function / method body
-max-branches=12
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of attributes for a class (see R0902).
-max-attributes=7
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=2
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-# Maximum number of boolean expressions in a if statement
-max-bool-expr=5
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=Exception

debian/changelog

@@ -1,5 +0,0 @@
-burp-ui (0.4.0-1) unstable; urgency=low
-
-  * Initial debian release
-
- -- Ziirish <hi+burpui@ziirish.me>  Wed, 24 Aug 2016 15:12:34 +0200

debian/compat

@@ -1 +0,0 @@
-9

debian/control

@@ -1,13 +0,0 @@
-Source: burp-ui
-Section: python
-Priority: extra
-Maintainer: Ziirish <hi+burpui@ziirish.me>
-Build-Depends: debhelper (>= 9), python, dh-virtualenv (>= 0.7), libffi-dev, libssl-dev, python-dev
-Standards-Version: 3.9.5
-
-Package: burp-ui
-Architecture: any
-Pre-Depends: dpkg (>= 1.16.1), python2.7, ${misc:Pre-Depends}
-Depends: ${python:Depends}, ${misc:Depends}
-Description: Burp-UI dashboard for your Burp server
- Burp-UI provides an easy to use web-ui for Burp.

debian/files

@@ -1 +0,0 @@
-burp-ui_0.3.0-1_amd64.deb python extra

debian/rules

@@ -1,4 +0,0 @@
-#!/usr/bin/make -f
-
-%:
-	dh $@ --with python-virtualenv --no-test

doc-requirements.txt

@@ -1 +0,0 @@
-docs/requirements.txt

docker-compose.yml

@@ -1,47 +0,0 @@
-redis:
-  restart: always
-  image: redis
-
-#mariadb:
-#  restart: always
-#  image: mariadb
-#  environment:
-#    - MYSQL_USER=burpui
-#    - MYSQL_PASSWORD=burpui
-#    - MYSQL_DATABASE=burpuidb
-#    - MYSQL_RANDOM_ROOT_PASSWORD=yes
-## Additionally, you may want to persist data
-## volumes:
-##   - /var/lib/buistore/mariadb:/var/lib/mysql
-
-pgsql:
-  restart: always
-  image: registry.ziirish.me/ziirish/burp-ui:pgsql
-## Additionally, you may want to persist data
-## volumes:
-##   - /var/lib/buistore/pgsql:/var/lib/postgresql/data
-
-burpui:
-  restart: always
-  image: registry.ziirish.me/ziirish/burp-ui:latest
-  links:
-    - redis
-    - pgsql
-  ports:
-    - 127.0.0.1:5000:5000
-  volumes:
-    - /etc/burp:/etc/burp
-    - /var/spool/burp:/var/spool/burp
-# Additionally, you can override some default settings
-#  environment:
-#    - BURPUI_CONFIG=/etc/burp/burpui.cfg
-#    - BURPUI_VERBOSE=0
-#    - BURPUI_CLIENT_NAME=bui
-#    - BURPUI_UID=5337
-#    - BURPUI_GID=5337
-#    - BURP_CLIENT_CONFIG=/tmp/burp.conf
-#    - BURP_SERVER_CONFIG=/etc/burp/burp-server.conf
-#    - DATABASE_URL=mysql://burpui:burpui@pgsql/burpuidb
-#    - REDIS_SERVER=redis:6379
-#    - BURP_SERVER_ADDR=auto
-#    - TIMEZONE=Europe/Paris

docker/Dockerfile

@@ -10,11 +10,11 @@ RUN apt-get update \
  && dpkg-reconfigure -f noninteractive tzdata \
  && rm -rf /var/lib/apt/lists/*
 
-ADD . /burp-ui
+ADD .. /burp-ui
 
-ADD docker/docker-release/assets/setup/ /app/setup/
-ADD docker/docker-release/assets/config/ /app/setup/config/
-ADD docker/docker-release/assets/init /app/init
+ADD docker-release/assets/setup/ /app/setup/
+ADD docker-release/assets/config/ /app/setup/config/
+ADD docker-release/assets/init /app/init
 
 RUN chmod 755 /app/init
 RUN chmod 755 /app/setup/install

docker/README.rst

@@ -1,18 +1,43 @@
-Docker Images
+Docker images
 =============
 
-Here are the `docker`_ model used to build the demo.
+In this folder you will find different `docker`_ images that will allow you to
+easily set-up `Burp-UI`_.
 
-Howto
+It is organized like this:
+
+- `demo/ <demo/>`_ contains the images used to build the demo.
+- `docker-alpine/ <docker-alpine/>`_ contains a small but complete image based
+  on `alpine`_ and python 3.6.
+- `docker-release/ <docker-release/>`_ contains a complete image based on
+  `debian`_ and python 2.7.
+
+Usage
 -----
 
-In order to build the demo on your own infrastructure you have to run the
-following commands:
+Two Dockerfiles are provided in order to help you build those images.
+
+Here is how to build them:
 
 ::
 
-        docker-compose build
-        docker-compose up -d
+    cd ..
+    # build the debian-based docker image:
+    docker build -t $USER/burp-ui:latest -f docker/Dockerfile .
+    # if you prefer the alpine-based docker image:
+    docker build -t $USER/burp-ui:alpine -f docker/Dockerfile-py3.6 .
 
 
+Alternatively, images are built by the CI and you can freely use them thanks to
+the provided `docker-compose`_ config:
+
+::
+
+    docker-compose pull
+    docker-compose up -d
+
 .. _docker: https://www.docker.com/
+.. _docker-compose: https://docs.docker.com/compose/
+.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui
+.. _alpine: https://alpinelinux.org/
+.. _debian: https://www.debian.org/

docker/demo/README.rst

@@ -0,0 +1,21 @@
+Demo Images
+===========
+
+Here are the `docker`_ models used to build the Burp-UI's `demo`_.
+
+Usage
+-----
+
+In order to build the `demo`_ on your own infrastructure you have to run the
+following commands (assuming you have a working `docker`_ and
+`docker-compose`_):
+
+::
+
+        docker-compose build
+        docker-compose up -d
+
+
+.. _docker: https://www.docker.com/
+.. _docker-compose: https://docs.docker.com/compose/
+.. _demo: https://demo.burp-ui.org/

docker/demo/docker-compose.yml

@@ -0,0 +1,60 @@
+demo-burp1:
+  restart: always
+  build: docker-burp1/
+  volumes:
+    - /srv/demo/spool/burp1/backup:/var/spool/burp
+    - /srv/demo/spool/burp1/tmp:/tmp/bui
+
+demo-burp2:
+  restart: always
+  build: docker-burp2/
+  volumes:
+    - /srv/demo/spool/burp2/backup:/var/spool/burp
+    - /srv/demo/spool/burp2/tmp:/tmp/bui
+
+demo-redis:
+  restart: always
+  image: redis:3
+  command: redis-server --appendonly yes
+#  volumes:
+#    - /srv/demo/redis:/data
+
+#demo-mariadb:
+#  restart: always
+#  image: mariadb
+#  environment:
+#    - MYSQL_USER=burpui
+#    - MYSQL_PASSWORD=burpui
+#    - MYSQL_DATABASE=burpuidb
+#    - MYSQL_RANDOM_ROOT_PASSWORD=yes
+
+demo-pg:
+  restart: always
+  build: docker-pg/
+
+demo-cli1:
+  restart: always
+  build: docker-cli1/
+  volumes:
+    - /srv/demo/files:/home
+  links:
+    - demo-burp1
+
+demo-cli2:
+  restart: always
+  build: docker-cli2/
+  volumes:
+    - /srv/demo/files:/home
+  links:
+    - demo-burp2
+
+demo-bui:
+  restart: always
+  build: docker-burpui/
+  ports:
+    - 127.0.0.1:5005:5000
+  links:
+    - demo-redis
+    - demo-burp1
+    - demo-burp2
+    - demo-pg

docker/docker-compose.yml

@@ -1,25 +1,8 @@
-demo-burp1:
+redis:
   restart: always
-  build: docker-burp1/
-  volumes:
-    - /srv/demo/spool/burp1/backup:/var/spool/burp
-    - /srv/demo/spool/burp1/tmp:/tmp/bui
+  image: redis
 
-demo-burp2:
-  restart: always
-  build: docker-burp2/
-  volumes:
-    - /srv/demo/spool/burp2/backup:/var/spool/burp
-    - /srv/demo/spool/burp2/tmp:/tmp/bui
-
-demo-redis:
-  restart: always
-  image: redis:3
-  command: redis-server --appendonly yes
-  volumes:
-    - /srv/demo/redis:/data
-
-#demo-mariadb:
+#mariadb:
 #  restart: always
 #  image: mariadb
 #  environment:
@@ -27,33 +10,38 @@ demo-redis:
 #    - MYSQL_PASSWORD=burpui
 #    - MYSQL_DATABASE=burpuidb
 #    - MYSQL_RANDOM_ROOT_PASSWORD=yes
-demo-pg:
-  restart: always
-  build: docker-pg/
+## Additionally, you may want to persist data
+## volumes:
+##   - /var/lib/buistore/mariadb:/var/lib/mysql
 
-demo-cli1:
+pgsql:
   restart: always
-  build: docker-cli1/
-  volumes:
-    - /srv/demo/files:/home
+  image: registry.ziirish.me/ziirish/burp-ui:pgsql
+## Additionally, you may want to persist data
+## volumes:
+##   - /var/lib/buistore/pgsql:/var/lib/postgresql/data
+
+burpui:
+  restart: always
+  image: registry.ziirish.me/ziirish/burp-ui:latest-py3.6
   links:
-    - demo-burp1
-
-demo-cli2:
-  restart: always
-  build: docker-cli2/
-  volumes:
-    - /srv/demo/files:/home
-  links:
-    - demo-burp2
-
-demo-bui:
-  restart: always
-  build: docker-burpui/
+    - redis
+    - pgsql
   ports:
-    - 127.0.0.1:5005:5000
-  links:
-    - demo-redis
-    - demo-burp1
-    - demo-burp2
-    - demo-pg
+    - 127.0.0.1:5000:5000
+  volumes:
+    - /etc/burp:/etc/burp
+    - /var/spool/burp:/var/spool/burp
+# Additionally, you can override some default settings
+#  environment:
+#    - BURPUI_CONFIG=/etc/burp/burpui.cfg
+#    - BURPUI_VERBOSE=0
+#    - BURPUI_CLIENT_NAME=bui
+#    - BURPUI_UID=5337
+#    - BURPUI_GID=5337
+#    - BURP_CLIENT_CONFIG=/tmp/burp.conf
+#    - BURP_SERVER_CONFIG=/etc/burp/burp-server.conf
+#    - DATABASE_URL=mysql://burpui:burpui@pgsql/burpuidb
+#    - REDIS_SERVER=redis:6379
+#    - BURP_SERVER_ADDR=auto
+#    - TIMEZONE=Europe/Paris

tools/README.rst

@@ -0,0 +1,8 @@
+Tools
+=====
+
+These are tools for developers to run `Burp-UI`_ from the sources.
+
+.. warning:: DO NOT USE THIS IN PRODUCTION
+
+.. _Burp-UI: https://git.ziirish.me/ziirish/burp-ui