Add README
This commit is contained in:
65
README.md
Normal file
65
README.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# Amber Valley Community Hub
|
||||
|
||||
A VLESS fallback landing site — served to unauthenticated visitors to make the proxy server appear as a legitimate community website.
|
||||
|
||||
## Overview
|
||||
|
||||
This site acts as a decoy frontend for a VLESS proxy server. When a visitor accesses the server without the correct proxy credentials or path, they are served this community video library instead of a proxy handshake error. This prevents fingerprinting of the proxy endpoint.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **React 18** — UI framework
|
||||
- **Vite** — build tool
|
||||
- **Tailwind CSS** — styling (amber color theme)
|
||||
- **Nginx** — static file serving inside Docker
|
||||
- **Docker / Docker Compose** — containerized deployment
|
||||
|
||||
## Features
|
||||
|
||||
- Fake community events video library with 42+ locally-stored thumbnail previews
|
||||
- Amber-tinted modern UI with animations
|
||||
- Video click triggers an authorization dialog (non-functional by design)
|
||||
|
||||
## Development
|
||||
|
||||
Install dependencies:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
Run dev server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Generate video thumbnails:
|
||||
|
||||
```bash
|
||||
npm run generate-thumbnails
|
||||
```
|
||||
|
||||
Build for production:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
The site runs on port **8081** via Docker Compose.
|
||||
|
||||
Build and start:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
Stop:
|
||||
|
||||
```bash
|
||||
docker compose down
|
||||
```
|
||||
|
||||
The container serves the built static site via Nginx on port 80 internally, mapped to **8081** on the host.
|
||||
Reference in New Issue
Block a user