From 32e4e3ac00ab1b701c2cebd288bbb8565f760b9b Mon Sep 17 00:00:00 2001 From: Aidan Holland Date: Tue, 6 Sep 2022 09:28:58 -0400 Subject: [PATCH] Update Dockerfile and Docs (#100) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .github/workflows/docker-image.yml | 3 ++- CHANGELOG.md | 8 +++++++- Dockerfile | 24 +++++++++++++++++++--- README.md | 32 ++++++++++++++++++------------ fsociety/__version__.py | 2 +- 5 files changed, 50 insertions(+), 19 deletions(-) diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml index 2a9db97..44ee421 100644 --- a/.github/workflows/docker-image.yml +++ b/.github/workflows/docker-image.yml @@ -3,13 +3,14 @@ name: Docker Image CI on: push: branches: - - '**' + - 'main' tags: - 'v*.*.*' pull_request: branches: - 'main' + jobs: docker: runs-on: ubuntu-latest diff --git a/CHANGELOG.md b/CHANGELOG.md index 02c7ce1..5c29674 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Any unreleased changes +## [3.2.8] - 9-6-2022 + +- Update docker image + ## [3.2.7] - 4-30-2022 - Add Traitor @@ -149,7 +153,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Initial Release -[unreleased]: https://github.com/fsociety-team/fsociety/compare/v3.2.7...HEAD + +[unreleased]: https://github.com/fsociety-team/fsociety/compare/v3.2.8...HEAD +[3.2.8]: https://github.com/fsociety-team/fsociety/compare/v3.2.7...v3.2.8 [3.2.7]: https://github.com/fsociety-team/fsociety/compare/v3.2.6...v3.2.7 [3.2.6]: https://github.com/fsociety-team/fsociety/compare/v3.2.5...v3.2.6 [3.2.5]: https://github.com/fsociety-team/fsociety/compare/v3.2.4...v3.2.5 diff --git a/Dockerfile b/Dockerfile index cf32fc2..a174ac5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,24 @@ FROM python:3.11.0b5-alpine + +LABEL org.opencontainers.image.title="fsociety" \ + org.opencontainers.image.description="A Modular Penetration Testing Framework" \ + org.opencontainers.image.authors="fsociety-team " \ + org.opencontainers.image.licenses="MIT" \ + org.opencontainers.image.source="https://github.com/fsociety-team/fsociety" \ + org.opencontainers.image.documentation="https://fsociety.dev/" + +# Environment variables for efficient builds +ENV PYTHONUNBUFFERED=1 \ + PYTHONDONTWRITEBYTECODE=1 \ + PYTHONHASHSEED=random \ + PIP_NO_CACHE_DIR=off \ + PIP_DISABLE_PIP_VERSION_CHECK=on \ + PIP_DEFAULT_TIMEOUT=100 + COPY . /fsociety WORKDIR /fsociety -RUN apk --update add git nmap -RUN pip install -e . -CMD fsociety --info + +RUN apk add --update --no-cache git nmap && pip install -e . + +CMD ["--info"] +ENTRYPOINT ["fsociety"] diff --git a/README.md b/README.md index 8f57fe8..020ba6a 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ +

+ fsociety-team/fsociety +

+ # fsociety [![PyPI](https://img.shields.io/pypi/v/fsociety?color=orange&logo=pypi&logoColor=orange&style=flat-square)](https://pypi.org/project/fsociety/) [![Python Version](https://img.shields.io/badge/python-3.7%2B-blue?logo=python&style=flat-square)](https://www.python.org/downloads/) ![PyPI - Downloads](https://img.shields.io/pypi/dm/fsociety?style=flat-square) -[![Docker Cloud build](https://img.shields.io/docker/cloud/build/fsocietyteam/fsociety?style=flat-square)](https://hub.docker.com/r/fsocietyteam/fsociety) +[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/fsocietyteam/fsociety/latest?style=flat-square)](https://hub.docker.com/r/fsocietyteam/fsociety) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-organge.svg?logo=git&logoColor=organge&style=flat-square)](http://makeapullrequest.com) -[![Open in Visual Studio Code](https://img.shields.io/badge/VSCode-Open-0098FF)](https://open.vscode.dev/fsociety-team/fsociety) +[![Open in Visual Studio Code](https://img.shields.io/badge/VSCode-Open-0098FF?style=flat-square)](https://open.vscode.dev/fsociety-team/fsociety) +[![Twitter Follow](https://img.shields.io/twitter/follow/fsociety_team?color=blue&style=flat-square)](https://twitter.com/fsociety_team) A Modular Penetration Testing Framework -[![Packages](https://img.shields.io/badge/PACKAGES.md-red?style=flat-square)](https://github.com/fsociety-team/fsociety/blob/main/PACKAGES.md) [![Changelog](https://img.shields.io/badge/CHANGELOG.md-red?style=flat-square)](https://github.com/fsociety-team/fsociety/blob/main/CHANGELOG.md) - -[![fsociety](https://raw.githubusercontent.com/fsociety-team/fsociety/main/images/fsociety.png)](https://github.com/fsociety-team/fsociety) +[![Packages](https://img.shields.io/badge/PACKAGES.md-red?style=flat-square)](https://github.com/fsociety-team/fsociety/blob/main/PACKAGES.md) +[![Changelog](https://img.shields.io/badge/CHANGELOG.md-red?style=flat-square)](https://github.com/fsociety-team/fsociety/blob/main/CHANGELOG.md) -![cli](https://raw.githubusercontent.com/fsociety-team/fsociety/main/images/cli.png) +

+ fsociety cli +

## Install @@ -40,22 +46,22 @@ optional arguments: -s, --suggest suggest a tool ``` -## Develop +## Docker ```bash -git clone https://github.com/fsociety-team/fsociety.git -pip install -e ".[dev]" +docker pull fsocietyteam/fsociety +docker run -it fsocietyteam/fsociety fsociety ``` -## Docker +## Developing ```bash -docker pull fsocietyteam/fsociety -docker run -it fsocietyteam/fsociety fsociety +git clone https://github.com/fsociety-team/fsociety.git +pip install -e ".[dev]" ``` ## License This software is licensed under the [MIT](https://github.com/fsociety-team/fsociety/blob/main/LICENSE) License. -[![Twitter Follow](https://img.shields.io/badge/fuck%20it-ship%20it-blue?style=flat-square)](https://twitter.com/fsociety_team) [![Twitter Follow](https://img.shields.io/twitter/follow/fsociety_team?color=blue&style=flat-square)](https://twitter.com/fsociety_team) +![Fuck It Ship It](https://img.shields.io/badge/fuck%20it-ship%20it-blue?style=flat-square) diff --git a/fsociety/__version__.py b/fsociety/__version__.py index 75512b6..78e82ed 100644 --- a/fsociety/__version__.py +++ b/fsociety/__version__.py @@ -1 +1 @@ -__version__ = "3.2.7" +__version__ = "3.2.8"