diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..567608e --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Shubham Hibare + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 1b6f95c..5a12d2b 100644 --- a/README.md +++ b/README.md @@ -1 +1,92 @@ # go-rss-hub + + +[![Go Report Card](https://goreportcard.com/badge/github.com/hibare/go-rss-hub)](https://goreportcard.com/report/github.com/hibare/go-container-status) +[![Docker Hub](https://img.shields.io/docker/pulls/hibare/go-rss-hub)](https://hub.docker.com/r/hibare/go-rss-hub) +[![Docker image size](https://img.shields.io/docker/image-size/hibare/go-rss-hub/latest)](https://hub.docker.com/r/hibare/go-rss-hub) +[![GitHub issues](https://img.shields.io/github/issues/hibare/go-rss-hub)](https://github.com/hibare/go-rss-hub/issues) +[![GitHub pull requests](https://img.shields.io/github/issues-pr/hibare/go-rss-hub)](https://github.com/hibare/go-rss-hub/pulls) +[![GitHub](https://img.shields.io/github/license/hibare/go-rss-hub)](https://github.com/hibare/go-rss-hub/blob/main/LICENSE) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/hibare/go-rss-hub)](https://github.com/hibare/go-rss-hub/releases) + + +A REST API designed in go to check for a container status + +## Getting Started + +go-rss-hub is packaged as docker container. Docker image is available on [Docker Hub](https://hub.docker.com/r/hibare/go-rss-hub). + +### Docker run + +```shell +docker run -p 5000:5000 -e LISTEN_ADDR='0.0.0.0' hibare/go-rss-hub +``` + +### Docker Compose + +```yml +version: "3" +services: + go-rss-hub: + image: hibare/go-rss-hub + container_name: go-rss-hub + hostname: go-rss-hub + environment: + - LISTEN_ADDR=0.0.0.0 + ports: + - "5000:5000" + logging: + driver: "json-file" + options: + max-size: "500k" + max-file: "5" + +``` +## Endpoints + +1. Check health + +```shell +/ping/ +``` + +2. Docker hub rss +RSS feed for images published on Docker hub. + +```shell +/docker///tags/ +``` + +Example: +```shell +> curl http://127.0.0.1:5000/docker/hibare/vt_ip_monitor/tags/ + + + + hibare/vt_ip_monitor | Docker Hub Images + https://hub.docker.com/r/hibare/vt_ip_monitor + 2021-12-20T10:49:50Z + A Python 3 script to monitor your IP for malicious domains/URL. + + + hibare + + + hibare/vt_ip_monitor:latest + 2020-01-06T18:41:43Z + tag:hub.docker.com,2020-01-06:/r/hibare/moni/tags?name=latest + Docker image ID: 81667473, Status: inactive + + A Python 3 script to monitor your IP for malicious domains/URL. + + hibare + + + +``` + +## Supported Environment Variables +| Variable | Description | Default Value | +| --------- | ----------- | ------------- | +| LISTEN_ADDR | IP address to bind to | 127.0.0.1 | +| LISTEN_PORT | Port to bind to | 5000 |