https://github.com/iv-org/instances-api

Instances API website for Invidious.
https://github.com/iv-org/instances-api

Last synced: 4 days ago
JSON representation

Instances API website for Invidious.

• Host: GitHub
• URL: https://github.com/iv-org/instances-api
• Owner: iv-org
• License: agpl-3.0
• Created: 2019-09-05T00:41:06.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-08T20:40:31.000Z (5 months ago)
• Last Synced: 2024-06-08T21:45:25.898Z (5 months ago)
• Language: Crystal
• Homepage: https://api.invidious.io
• Size: 86.9 KB
• Stars: 70
• Watchers: 8
• Forks: 33
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [api.invidious.io/](https://api.invidious.io/)

[![Build Status](https://github.com/iv-org/instances-api/workflows/api.invidious.io%20CI/badge.svg)](https://github.com/iv-org/instances-api/actions)

Status page for [Invidious](https://github.com/iv-org/invidious) instances, sourced from [the documentation](https://docs.invidious.io/instances/).

## Installation

```bash

$ git clone https://github.com/iv-org/instances-api

$ cd instances-api

$ shards install

$ crystal build src/instances.cr --release

```

## Usage

```bash

$ ./instances -h

    -b HOST, --bind HOST             Host to bind (defaults to 0.0.0.0)

    -p PORT, --port PORT             Port to listen for connections (defaults to 3000)

    -s, --ssl                        Enables SSL

    --ssl-key-file FILE              SSL key file

    --ssl-cert-file FILE             SSL certificate file

    -h, --help                       Shows this help

```

## Contributing

1. Fork it ()

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

- [Omar Roth](https://github.com/omarroth) - original creator