Skip to content

Arthur2500/Sherlock-Web

Repository files navigation

Docker Image CI

Sherlock Web Icon

A web interface for Sherlock. All credits belong to them, this is just a simple frontend.

Demo:

https://sherlock.ziemlich-schnell.de

How to run:

Use Prebuilt Image (Recommended)

docker run --name sherlock-web -p 3000:3000 -e NODE_ENV=production -e SECURITY=enabled --restart unless-stopped ghcr.io/arthur2500/sherlock-web:latest

or

mkdir Sherlock-Web &&
cd Sherlock-Web &&
wget https://raw.githubusercontent.com/Arthur2500/Sherlock-Web/main/docker-compose.yml &&
docker-compose up -d

Build Docker Image Locally

git clone https://github.com/Arthur2500/Sherlock-Web.git &&
docker-compose -f docker-compose.local.yml up -d --build

Run without Docker

Requirements:

Node.js >= 16
Sherlock (https://github.com/sherlock-project/sherlock)

Clone Repository

git clone https://github.com/Arthur2500/Sherlock-Web.git

Install dependencies

npm install

Run main.js

node server.js

For improved security, set environment variable SECURITY=enabled if exclusively accessed via Cloudflare Tunnel or localhost

SECURITY=enabled node main.js

Configuration

docker-compose.yml Environment Settings:

  • SECURITY: [enabled/disabled]: Enable/Disable Security features such as Helmet header protection

Screenshots

Bildschirmfoto 2024-09-16 um 23 10 28 Bildschirmfoto 2024-09-16 um 23 11 15 Bildschirmfoto 2024-09-16 um 23 13 12 Bildschirmfoto 2024-09-16 um 23 12 55