mirror of
https://github.com/iv-org/instances-api.git
synced 2025-02-18 13:54:15 -05:00
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
# [instances.invidio.us](https://instances.invidio.us)
|
|
|
|
[](https://github.com/iv-org/instances.invidio.us/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).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ git clone https://github.com/iv-org/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/iv-org/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) - original creator
|