metacog

a tiny metadata retriever with metascraper

Usage

1. Launch server.
2. Request to server with site URL in url parameter.

Behavior

$ curl https://your-metacog-server/?url=https://github.com

returns

{
  "author": null,
  "date": null,
  "description": "GitHub is where over 100 million developers shape the future of software, together. Contribute to the open source community, manage your Git repositories, review code like a pro, track bugs and fea…",
  "feed": null,
  "image": "https://github.githubassets.com/images/modules/site/social-cards/campaign-social.png",
  "lang": "en",
  "logo": null,
  "publisher": "GitHub",
  "title": "GitHub: Let’s build from here",
  "video": null,
  "url": "https://github.com/"
}

Run locally

• Requirements
  • Node.js 20.x
  • npm@10

$ npm i
$ npm run dev

Run locally with compose

• Requirements
  • Docker Desktop or equivalent

$ docker compose up

Use container image

See Container registry

Build Docker image

$ docker build .

Configuration

environment variables:

• PORT
  • Port to expose app
  • if undefined, 3000
• REDIS_HOST
  • Redis host for caching
  • if undefined, memory cache is used
• REDIS_PORT
  • Redis port
  • if undefined, 6379
• REDIS_FAMILY
  • IP version for Redis connection
  • if undefined, 4
• REDIS_USER
  • Redis username
  • if undefined, default
• REDIS_PASS
  • Redis password
• REDIS_TIMEOUT
  • Redis command timeout
  • in millisecond
• ALLOWED_ORIGIN
  • Allowed origins for CORS
  • Write in space-delimited regular expressions
  • Access-Control-Allow-Origin
  • set blank for Access-Control-Allow-Origin: *
• CACHE_TTL
  • Cache retention period for fetched data
  • in seconds
  • if undefined, 24hour
• CACHE_CHECK
  • Effective only with memory cache
  • Cache expiration check interval
  • in seconds

Deploy to Fly.io

1. Set up your account & app & cli
2. $ flyctl redis create (if you use Redis)
3. $ cp sample.fly.toml fly.toml
4. Enter your app name in fly.toml
5. $ npm run deploy