Skip to content
This repository has been archived by the owner on Jun 19, 2024. It is now read-only.
/ image-logger Public archive

๐Ÿ–ผ๏ธ This is a simple image logger that logs images to a file and sending them to a discord webhook.

License

Notifications You must be signed in to change notification settings

PunGrumpy/image-logger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

72 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ–ผ๏ธ Image Logger

๐Ÿ“ Description

This is a simple image logger that logs images to a file and sending them to a discord webhook.

๐Ÿ“š How to use

๐Ÿ“ฆ Requirements

  • Node.js v20.0.0 or higher
  • NPM v7.0.0 or higher
  • PNPM v6.0.0 or higher

๐Ÿ“ฅ Installation

pnpm install

โš™๏ธ Configuration

Create a config.json you can use the config.example.json as a template.

{
  "webhooks": [
    {
      "name": "NAME OF WEBHOOK",
      "url": "URL OF WEBHOOK"
    }
  ],
  "image": [
    {
      "name": "NAME OF IMAGE",
      "path": "URL OF IMAGE or PATH OF IMAGE" // src/assets/IMAGE_NAME.png
    },
    {
      "name": "NAME OF IMAGE",
      "path": "URL OF IMAGE or PATH OF IMAGE" // src/assets/IMAGE_NAME.png
    }
  ]
}

You can also use enviroment variables to configure the project.

HEALTHCHECK_USER_AGENT=USER AGENT FOR HEALTHCHECK # Edit on Dockerfile

and then update your environment variables on your machine.

export HEALTHCHECK_USER_AGENT="USER AGENT FOR HEALTHCHECK"

Note: You can add as webhooks url on config.json as you want.

๐Ÿ–ผ๏ธ Preparing images

  1. Create a folder called assets or whatever you want in the src folder.
  2. Add your images to the folder.
  3. Add the images path to the config.json file.

๐Ÿ“ Post Image

You can POST images to the /image endpoint.

๐ŸšŒ Deploying

๐Ÿ’ป Local

pnpm start

๐Ÿณ Docker

docker compose up -d

โ–ฒ Vercel

You can using the Vercel platform to deploy this project.

Note: Don't forget to add the config and image to the project before deploying.

๐Ÿ“ API

๐Ÿ–ผ๏ธ Post Image

curl -X POST -H "Content-Type: application/json" -d '{"image": "IMAGE URL", "imageName": "IMAGE NAME"}' http://localhost:3000/image

๐Ÿ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

About

๐Ÿ–ผ๏ธ This is a simple image logger that logs images to a file and sending them to a discord webhook.

Topics

Resources

License

Stars

Watchers

Forks