Skip to content

Commit

Permalink
[pytx] Remove docker run from README.md (#1629)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dcallies authored Sep 27, 2024
1 parent 4f92640 commit 1662302
Showing 1 changed file with 7 additions and 21 deletions.
28 changes: 7 additions & 21 deletions python-threatexchange/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,20 @@ To get similar functionality in a deployable service, check out hasher-matcher-a

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/facebook/ThreatExchange/python-threatexchange-ci.yaml?branch=main) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/threatexchange) ![PyPI - Downloads](https://img.shields.io/pypi/dm/threatexchange) ![PyPI](https://img.shields.io/pypi/v/threatexchange) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## Run the CLI in Docker container

A Dockerfile is provided which allows you to run the CLI with minimal dependencies.
## Installation

First build the container:
If you don't have `pip`, learn how to install it [here](https://pip.pypa.io/en/stable/installation/).

```bash
$ python3 -m pip install threatexchange --upgrade
```
$ docker build --tag threatexchange .
```

Then run:

```
$ docker run threatexchange
```
### Docker File

To persist the configuration and data between invocations, mount the `/var/lib/threatexchange` volume:
A Dockerfile is provided which allows you to run the CLI with minimal dependencies.

```
$ docker run --volume $HOME/.threatexchange:/var/lib/threatexchange
```

## Installation

If you don't have `pip`, learn how to install it [here](https://pip.pypa.io/en/stable/installation/).

```bash
$ python3 -m pip install threatexchange --upgrade
$ docker build --tag threatexchange .
```

# Introduction
Expand Down

0 comments on commit 1662302

Please sign in to comment.