github.com/bluestoneag/bluephish@v0.1.0/README.md (about) 1 ![BluePhish Logo Wallpaper](docs/images/bluephish_logo_wallpaper.png) 2 3 BluePhish 4 ======= 5 6 ![Build Status](https://github.com/bluestoneag/bluephish/workflows/CI/badge.svg) 7 [![GoDoc](https://godoc.org/github.com/gophish/gophish?status.svg)](https://godoc.org/github.com/gophish/gophish) 8 [![Go Report Card](https://goreportcard.com/badge/github.com/bluestoneag/bluephish)](https://goreportcard.com/report/github.com/bluestoneag/bluephish) 9 ![GitHub top language](https://img.shields.io/github/languages/top/bluestoneag/bluephish) 10 ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/bluestoneag/bluephish) 11 ![GitHub package.json version](https://img.shields.io/github/package-json/v/bluestoneag/bluephish) 12 ![open issues](https://img.shields.io/github/issues-raw/bluestoneag/bluephish) 13 ![license](https://img.shields.io/github/license/bluestoneag/bluephish) 14 15 16 BluePhish: Open-Source Phishing Toolkit (Direct Fork of [GoPhish](https://github.com/gophish/gophish)) 17 18 [Gophish](https://getgophish.com) is an open-source phishing toolkit designed for businesses and penetration testers. It provides the ability to quickly and easily setup and execute phishing engagements and security awareness training. 19 20 ## Database 21 22 The BluePhish version of GoPhish supports currently **only** `sqlite3`. 23 24 ## Deployment 25 26 ### Environment Variables 27 28 You can define the following env variables for configuring the BluePhish instance: 29 | Variable | Purpose | Default Value | 30 | :--- | :--- | :--- | 31 | `BLUEPHISH_INITIAL_ADMIN_PASSWORD` | set an initial admin password | `bluephish` | 32 | `BLUEPHISH_INITIAL_ADMIN_API_TOKEN` | set an initial admin api token | *randomly generated* | 33 34 ### Docker 35 ```bash 36 docker pull ghcr.io/bluestoneag/bluephish:latest 37 ``` 38 39 *sample docker-compose file*: [docker-compose.yaml](docs/deployment/docker/docker-compose.yaml) 40 41 ### Kubernetes 42 Edit and apply the kustomization files in the [kubernetes](docs/deployment/kubernetes) directory. 43 For every campagne you have to create a specific ingress ressource in the `ingress.yaml`. 44 The ingress ressource should refer to the `bluephish-webserver` service on port `80` defined in the `services.yaml`. 45 46 ## Documentation 47 48 Documentation can be found on our [site](https://bluestoneag.github.io/bluephish). Find something missing? Let us know by filing an issue! 49 50 ## Issues 51 52 - Found a bug? 53 - Want more features? 54 - Find something missing in the documentation? 55 56 Let us know! Please don't hesitate to [file an issue](https://github.com/bluestoneag/bluephish/issues/new) and we'll get right on it. 57 58 ## GoPhish License 59 As mentioned before BluePhish is a direct fork of the GoPhish Version 0.11.0 (https://github.com/gophish/gophish). 60 This means that a the most code is provided by GoPhish and the license of the GoPhish is the same as the license of the BluePhish.