https://github.com/arthur2500/sherlock-web
A web interface for Sherlock.
https://github.com/arthur2500/sherlock-web
javascript nodejs self-hosted sherlock-project webapp
Last synced: 2 months ago
JSON representation
A web interface for Sherlock.
- Host: GitHub
- URL: https://github.com/arthur2500/sherlock-web
- Owner: Arthur2500
- License: gpl-3.0
- Created: 2024-08-29T10:21:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T07:01:55.000Z (about 1 year ago)
- Last Synced: 2025-05-05T08:22:02.048Z (about 1 year ago)
- Topics: javascript, nodejs, self-hosted, sherlock-project, webapp
- Language: JavaScript
- Homepage: https://sherlock.ziemlich-schnell.de
- Size: 418 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/Arthur2500/Sherlock-Web/actions/workflows/docker-image.yml)
# Sherlock Web 
A web interface for [Sherlock](https://github.com/sherlock-project/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
