Skip to content
This repository was archived by the owner on Jun 24, 2020. It is now read-only.

Commit a8e818b

Browse files
committed
add docker compose. Update README.
1 parent 5803957 commit a8e818b

5 files changed

Lines changed: 38 additions & 7 deletions

File tree

.dockerignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
docker-compose.yml
2+
.env
3+
README.md
4+
.travis-ci.yml
5+
.gitignore

.env

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
COMPOSE_PROJECT_NAME="burp-server"

.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Created by https://www.gitignore.io/api/linux
2+
3+
### Linux ###
4+
*~
5+
6+
# temporary files which can be created if a process still has a handle open of a deleted file
7+
.fuse_hidden*
8+
9+
# KDE directory preferences
10+
.directory
11+
12+
# Linux trash folder which might appear on any partition or disk
13+
.Trash-*

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ docker create \
2727
* `-p 4971 -p 4972` - the port(s)
2828
* `-v /etc/burp` - Configuration file location
2929
* `-v /data` - Location for backups
30-
* `-e ENABLE_CRON_SUMMARY=0` - Enables emailing a daily summary (default: false) - *optional*
31-
* `-e BURP_EMAIL="[email protected]"` - Sets the email address to send the daily summary to. - *only required if cron summary is enabled*
32-
* `-e ENABLE_CRON_DEDUP=1` - Disables running dedup cron job (default: true) - *optional*
30+
* `-e ENABLE_CRON_DEDUP=1` - Enables burp dedup (default: true) - *optional*
3331

34-
It is based on alpine linux with ssh disabled, for shell access whilst the container is running do `docker exec -it burp-server /bin/bash`.
32+
Otherwise you can use docker compose. Just edit the `docker-compose.yml` file and run `docker-compose up -d burp-server` to start the server in the background.
33+
34+
It is based on alpine linux with ssh disabled, for shell access whilst the container is running do `docker exec -it burp-server /bin/bash` or with docker compose `docker-compose exec burp-server /bin/bash`.
3535

3636
## Setting up the application
3737

@@ -43,13 +43,12 @@ The version number corresponds to what version of burp server you want to run. T
4343

4444
### Available Versions
4545

46-
* latest - latest version 2 (once I finish setting up the stable version)
47-
* 1.4.40 - Stable
46+
[Tags](https://hub.docker.com/r/computerfr33k/burp-server/tags/)
4847

4948
## Updates
5049

5150
* The docker image is now based on alpine linux and configs are now located in `/etc/burp`.
52-
* To monitor the logs of the container in realtime `docker logs -f burp-server`.
51+
* To monitor the logs of the container in realtime `docker logs -f burp-server` or with docker compose `docker-compose logs -f burp-server`.
5352

5453
## Version History
5554

docker-compose.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: '2'
2+
3+
services:
4+
burp-server:
5+
image: computerfr33k/burp-server:latest
6+
environment:
7+
- ENABLE_CRON_DEDUP=1
8+
ports:
9+
- "4971:4971"
10+
- "4972:4972"
11+
volumes:
12+
- "/var/spool/burp:/data"
13+
- "/etc/burp:/etc/burp"

0 commit comments

Comments
 (0)