crog

Version, currently 0.0.22 versions

github.com/uu/crog

Crystal Opengraph proxy

0 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  crog:
    github: uu/crog
    version: ~> 0.0.2

Then run:

shards install

shard.yml

Crystal
1.11.2
License
MIT
Author
Michael Pirogov
Target
  • crog from src/crog.cr

Dependencies

Runtime Dependencies

  • redis*github: stefanwille/crystal-redis
  • sanitize*github: straight-shoota/sanitize
  • opengraph*github: uu/opengraph.cr
  • validator*github: nicolab/crystal-validator
  • crometheus*github: darwinnn/crometheus, branch: master
  • json_on_steroids*github: anykeyh/json_on_steroids, branch: master

Development Dependencies

  • ameba~> 1.6.1github: crystal-ameba/amebadev

README

Opengraph caching proxy

Fetches opengraph meta and translates it to JSON.

Installation

Docker

Requirements: docker-compose 2.24+

docker compose up -d

Using

curl localhost:8080 -d '{"uri": "telegram.org"}' && echo

Configuring

Mix in JSON object to response.

--mixin '{"contentType": "openGraph"}' or MIXIN variable in docker-compose

Default: {}

Use custom template for response. <data> is replaces with default og answer.

--template '{"meta":{"status":200,"errors":[],"pagination":[]},"data":<data>}' or TEMPLATE variable in docker-compose

Default: <data>

Contributing

  1. Fork it (https://github.com/uu/crog/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors