Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docker integration and additional documentation #5

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Use a base image of Python
FROM python:3.9-slim

# Set the working directory
WORKDIR /app

# Copy the necessary files to the container
COPY . /app

# Install the dependencies
RUN pip install --no-cache-dir -r requirements.txt

# Default command to run
ENTRYPOINT ["python3", "forbiddenpass.py"]
50 changes: 50 additions & 0 deletions README.Docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# DOCKER

Follow these steps to install and run ForbiddenPass in Docker.

## Clone the Repository

First, clone the repository:

```bash

git clone https://github.com/gotr00t0day/forbiddenpass.git

cd forbiddenpass
```
## Build the Docker Image

Build the Docker image using the following command in the same directory where the Dockerfile is located.

```bash
docker build -t forbiddenpass .
```
## Usage

Once the image is built, you can run the container using the following commands:

Domains to check
```
docker run --rm -v $(pwd):/app forbiddenpass -d domains.txt
```

Domains to check with a path
```
docker run --rm -v $(pwd):/app forbiddenpass -d domains.txt --path login
```


> **Note**
-v $(pwd):/app: This option mounts the current working directory on your host machine to the /app directory inside the container. This allows the container to access files in your current directory, such as domains.txt

> **Note**
Ensure that domains.txt is located in your current working directory when executing the docker run command.

Scan a single target
```
docker run --rm forbiddenpass -t https://site
```
Scan a single target with a path
```
docker run --rm forbiddenpass -t https://site --path login
````
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Thanks to Knowledge-Wisdom-Understanding (MrPMillz) for making the script cleane

# INSTALLATION

You can install locally or use Docker instead.

If you choose to install locally, follow these steps:

```bash

git clone https://github.com/gotr00t0day/forbiddenpass.git
Expand All @@ -16,6 +20,9 @@ python3 forbiddenpass.py -h

```

> **Note**
If you prefer using Docker, [click here to jump to the Docker README](./README.Docker.md).

# USAGE

```bash
Expand Down