Skip to content

Commit c7fd291

Browse files
committed
Rewrite Readme
1 parent f83f899 commit c7fd291

File tree

3 files changed

+93
-49
lines changed

3 files changed

+93
-49
lines changed
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 93 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
<!-- Zphisher -->
22

33
<p align="center">
4-
<img src=".imgs/logo.png">
4+
<img src=".github/misc/logo.png">
55
</p>
66

77
<p align="center">
8-
<img src="https://img.shields.io/badge/Version-2.2-green?style=for-the-badge">
8+
<img src="https://img.shields.io/badge/Version-2.3.0-green?style=for-the-badge">
99
<img src="https://img.shields.io/github/license/htr-tech/zphisher?style=for-the-badge">
1010
<img src="https://img.shields.io/github/stars/htr-tech/zphisher?style=for-the-badge">
1111
<img src="https://img.shields.io/github/issues/htr-tech/zphisher?color=red&style=for-the-badge">
1212
<img src="https://img.shields.io/github/forks/htr-tech/zphisher?color=teal&style=for-the-badge">
1313
</p>
1414

1515
<p align="center">
16-
<img src="https://img.shields.io/badge/Author-HTR--Tech-cyan?style=flat-square">
17-
<img src="https://img.shields.io/badge/Open%20Source-Yes-cyan?style=flat-square">
18-
<img src="https://img.shields.io/badge/Written%20In-Bash-cyan?style=flat-square">
16+
<img src="https://img.shields.io/badge/Author-htr--tech-blue?style=flat-square">
17+
<img src="https://img.shields.io/badge/Open%20Source-Yes-darkgreen?style=flat-square">
18+
<img src="https://img.shields.io/badge/Maintained%3F-Yes-lightblue?style=flat-square">
19+
<img src="https://img.shields.io/badge/Written%20In-Bash-darkcyan?style=flat-square">
1920
</p>
2021

21-
<p align="center">A beginners friendly, Automated phishing tool with 30+ templates.</p>
22+
<p align="center"><b>A beginners friendly, Automated phishing tool with 30+ templates.</b></p>
2223

2324
##
2425

@@ -37,73 +38,116 @@ It only demonstrates "how phishing works". <b>You shall not misuse the informati
3738
### Features
3839

3940
- Latest and updated login pages.
40-
- Mask URL support
4141
- Beginners friendly
42-
- Docker support (checkout `docker-legacy` branch)
4342
- Multiple tunneling options
4443
- Localhost
45-
- Ngrok (With or without hotspot)
46-
- Cloudflared (Alternative of Ngrok)
44+
- Ngrok
45+
- Cloudflared
46+
- LocalXpose
47+
- Mask URL support
48+
- Docker support
4749

50+
##
4851

4952
### Installation
5053

5154
- Just, Clone this repository -
52-
```
53-
$ git clone https://github.com/htr-tech/zphisher.git
54-
```
55+
```
56+
git clone --depth=1 https://github.com/htr-tech/zphisher.git
57+
```
5558

56-
- Change to cloned directory and run `zphisher.sh` -
57-
```
58-
$ cd zphisher
59-
$ bash zphisher.sh
60-
```
59+
- Now go to cloned directory and run `zphisher.sh` -
60+
```
61+
$ cd zphisher
62+
$ bash zphisher.sh
63+
```
6164

62-
- On first launch, It'll install the dependencies and that's it. `Zphisher` is installed.
65+
- On first launch, It'll install the dependencies and that's it. ***Zphisher*** is installed.
66+
67+
##
6368

6469
### Run on Docker
65-
```
66-
$ docker pull htrtech/zphisher
67-
$ docker run --rm -it htrtech/zphisher
68-
```
6970

70-
### Dependencies
71+
- Docker Image Mirror:
72+
- **DockerHub** :
73+
```
74+
docker pull htrtech/zphisher
75+
```
76+
- **GHCR** :
77+
```
78+
docker pull ghcr.io/htr-tech/zphisher:latest
79+
```
80+
81+
- By using the wrapper script [**run-docker.sh**](https://raw.githubusercontent.com/htr-tech/zphisher/master/run-docker.sh)
82+
83+
```
84+
$ curl -LO https://raw.githubusercontent.com/htr-tech/zphisher/master/run-docker.sh
85+
$ bash run-docker.sh
86+
```
87+
- Temporary Container
88+
89+
```
90+
docker run --rm -ti htrtech/zphisher
91+
```
92+
- Remember to mount the `auth` directory.
7193
72-
**`Zphisher`** requires following programs to run properly -
73-
- `php`
74-
- `wget`
75-
- `curl`
94+
##
95+
96+
<details>
97+
<summary><h3>Dependencies</h3></summary>
98+
99+
<b>Zphisher</b> requires following programs to run properly -
76100
- `git`
101+
- `curl`
102+
- `php`
103+
104+
> All the dependencies will be installed automatically when you run **Zphisher** for the first time.
105+
</details>
77106
78-
> All the dependencies will be installed automatically when you run `Zphisher` for the first time.
107+
<details>
108+
<summary><h3>Tested on</h3></summary>
79109
80-
> Supported Platform : **`Termux`**, **`Ubuntu/Debian/Kali/Parrot`**, **`Arch Linux/Manjaro`**, **`Fedora`**
110+
- **Ubuntu**
111+
- **Debian**
112+
- **Arch**
113+
- **Manjaro**
114+
- **Fedora**
115+
- **Termux**
116+
</details>
81117
82118
##
83119
84-
<h3 align="center">
85-
:: Workflow ::
86-
</h3>
120+
<h3 align="center"><i>:: Workflow ::</i></h3>
87121
<p align="center">
88-
<img src=".imgs/wf.gif"/>
122+
<img src=".github/misc/workflow.gif"/>
89123
</p>
90124
91-
### Special Thanks :
92-
93-
- [**Aditya Shakya**](https://github.com/adi1090x)
94-
- [**1RaY-1**](https://github.com/1RaY-1)
95-
- [**Yisus7u7**](https://github.com/Yisus7u7)
96-
- [**sepp0**](https://github.com/sepp0)
97-
- [**AliMilani**](https://github.com/AliMilani)
98-
- [**TheLinuxChoice**](https://twitter.com/linux_choice)
99-
- [**DarksecDevelopers**](https://github.com/DarksecDevelopers)
100-
- [**Moises Tapia**](https://github.com/MoisesTapia)
101-
125+
##
102126
103-
### Find Me on :
127+
### Find Me on:
104128
<p align="left">
105-
<a href="https://github.com/htr-tech" target="_blank"><img src="https://img.shields.io/badge/Github-HTR--TECH-green?style=for-the-badge&logo=github"></a>
106-
<a href="https://www.instagram.com/tahmid.rayat" target="_blank"><img src="https://img.shields.io/badge/IG-%40tahmid.rayat-red?style=for-the-badge&logo=instagram"></a>
107-
<a href="https://m.me/tahmid.rayat.official" target="_blank"><img src="https://img.shields.io/badge/Chat-Messenger-blue?style=for-the-badge&logo=messenger"></a>
129+
<a href="https://tahmidrayat.is-a.dev" target="_blank"><img src="https://img.shields.io/badge/Socials-grey?style=for-the-badge&logo=linktree"></a>
130+
<a href="https://github.com/htr-tech" target="_blank"><img src="https://img.shields.io/badge/Github-blue?style=for-the-badge&logo=github"></a>
108131
</p>
109132
133+
134+
### *Thanks to all contributors*:
135+
136+
<table>
137+
<tr align="center">
138+
<td><a href="https://github.com/1RaY-1"><img src="https://avatars.githubusercontent.com/u/78962948?s=100" /><br /><sub><b>1RaY-1</b></sub></a></td>
139+
<td><a href="https://github.com/adi1090x"><img src="https://avatars.githubusercontent.com/u/26059688?s=100" /><br /><sub><b>Aditya Shakya</b></sub></a></td>
140+
<td><a href="https://github.com/AliMilani"><img src="https://avatars.githubusercontent.com/u/59066012?s=100" /><br /><sub><b>Ali Milani</b></sub></a></td>
141+
<td><a href="https://github.com/Meht-evaS"><img src="https://avatars.githubusercontent.com/u/57435273?s=100" /><br /><sub><b>AmnesiA</b></sub></a></td>
142+
<td><a href="https://github.com/KasRoudra"><img src="https://avatars.githubusercontent.com/u/78908440?s=100" /><br /><sub><b>KasRoudra</b></sub></a></td>
143+
</tr>
144+
<tr align="center">
145+
<td><a href="https://github.com/MoisesTapia"><img src="https://avatars.githubusercontent.com/u/28166400?s=100" /><br /><sub><b>Moises Tapia</b></sub></a></td>
146+
<td><a href="https://github.com/BDhackers009"><img src="https://avatars.githubusercontent.com/u/67186139?s=100" /><br /><sub><b>Mustakim Ahmed</b></sub></a></td>
147+
<td><a href="https://github.com/sepp0"><img src="https://avatars.githubusercontent.com/u/36642137?s=100" /><br /><sub><b>sepp0</b></sub></a></td>
148+
<td><a href="https://github.com/TripleHat"><img src="https://avatars.githubusercontent.com/u/68332137?s=100" /><br /><sub><b>TripleHat</b></sub></a></td>
149+
<td><a href="https://github.com/Yisus7u7"><img src="https://avatars.githubusercontent.com/u/64093255?s=100" /><br /><sub><b>Yisus7u7</b></sub></a></td>
150+
</tr>
151+
<table>
152+
153+
<!-- // -->

0 commit comments

Comments
 (0)