sherlock Docker & Self-Hosted Deployment

GitHub

Hunt down social media accounts by username across social networks

1. Pull Image (DOCKERHUB) docker pull sherlock-project/sherlock:latest
2. Docker Run (1-Click Launch) docker run -d --name sherlock --restart always sherlock-project/sherlock:latest
3. Podman Run podman run -d --name sherlock --restart always sherlock-project/sherlock:latest
4. Skopeo Inspect (Zero-Pull Manifest) skopeo inspect docker://docker.io/sherlock-project/sherlock:latest
5. ORAS Pull (OCI Artifact) oras pull sherlock-project/sherlock:latest
Dockerfile
# Release instructions:
  # 1. Update the version tag in the Dockerfile to match the version in sherlock/__init__.py
  # 2. Update the VCS_REF tag to match the tagged version's FULL commit hash
  # 3. Build image with BOTH latest and version tags
    # i.e. `docker build -t sherlock/sherlock:0.16.0 -t sherlock/sherlock:latest .`

FROM python:3.12-slim-bullseye AS build
WORKDIR /sherlock

RUN pip3 install --no-cache-dir --upgrade pip

FROM python:3.12-slim-bullseye
WORKDIR /sherlock

ARG VCS_REF= # CHANGE ME ON UPDATE
ARG VCS_URL="https://github.com/sherlock-project/sherlock"
ARG VERSION_TAG= # CHANGE ME ON UPDATE

ENV SHERLOCK_ENV=docker

LABEL org.label-schema.vcs-ref=$VCS_REF \
      org.label-schema.vcs-url=$VCS_URL \
      org.label-schema.name="Sherlock" \
      org.label-schema.version=$VERSION_TAG \
      website="https://sherlockproject.xyz"

RUN pip3 install --no-cache-dir sherlock-project==$VERSION_TAG

WORKDIR /sherlock

ENTRYPOINT ["sherlock"]