Skip to content

Latest commit

 

History

History
38 lines (32 loc) · 1.81 KB

README.md

File metadata and controls

38 lines (32 loc) · 1.81 KB
Raw

discord-phishing-backend

Discord Phishing API list with Redis and Docker

Access to API

API Endpoints

Authorization

Some API requests require the use of a generated API key. To set API key, please add AUTHORIZATION to your .env file. If not the default API key is secret. To authenticate an API request, you should provide your API key in the Authorization header.

Method Endpoint Description Require Authorzation Header?
GET /all Get all data (includes blacklist links and domains) No
GET /links Get all blacklist domains No
GET /check?url={query} Check if a url is in blacklist No
GET /trace-redirect?url={query} Trace redirect a url (shorten link) No
POST /adddomain Add domain to blacklist (Require url in body) Yes
POST /addlink Add link to blacklist (Require url in body) Yes

Installation

Without Docker

Redis

  • Download and setup redis

Project

  1. Clone the project
  2. Rename example.env to .env
  3. Change REDIS_HOST to your host (usually localhost)
  4. Change others variable to fit your environment (REDIS_PORT, REDIS_PASSWORD, PORT, TIMEZONE)
  5. Install package using npm install or yarn install
  6. Run npm start

With Docker

  1. Clone the project
  2. Rename example.env to .env
  3. Change others variable to fit your environment (PORT, TIMEZONE)
  4. Run docker-compose up -d to run the container