instances-api/README.md

39 lines
1.3 KiB
Markdown
Raw Normal View History

2021-08-10 13:12:03 +00:00
# [api.invidious.io/](https://api.invidious.io/)
2019-09-05 01:03:33 +00:00
2021-08-10 14:45:51 +00:00
[![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://github.com/iv-org/documentation/blob/master/Invidious-Instances.md).
2019-09-05 01:03:33 +00:00
## Installation
```bash
2021-08-10 14:45:51 +00:00
$ git clone https://github.com/iv-org/instances-api
$ cd instances-api
2019-09-05 01:03:33 +00:00
$ 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
2021-08-10 14:45:51 +00:00
1. Fork it (<https://github.com/iv-org/instances-api/fork>)
2019-09-05 01:03:33 +00:00
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
2020-12-01 17:27:14 +00:00
- [Omar Roth](https://github.com/omarroth) - original creator