instances-api/README.md

37 lines
1.2 KiB
Markdown
Raw Normal View History

2019-09-05 01:03:33 +00:00
# [instances.invidio.us](https://instances.invidio.us)
2019-09-11 03:32:16 +00:00
Status page for [Invidious](https://github.com/omarroth/invidious) instances, sourced from [here](https://github.com/omarroth/invidious/wiki/Invidious-Instances).
2019-09-05 01:03:33 +00:00
## Installation
```bash
$ git clone https://github.com/omarroth/instances.invidio.us
$ cd instances.invidio.us
$ 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 (<https://github.com/omarroth/instances.invidio.us/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
- [Omar Roth](https://github.com/omarroth) - creator and maintainer