iv-org-mirror/instances-api
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/instances-api.git synced 2024-08-15 00:53:15 +00:00
Code Issues Projects Releases Packages Wiki Activity
instances-api/README.md
TheFrenchGhosty e46bf0d710
Update the README
2021-08-10 16:45:51 +02:00

1.3 KiB
Raw Blame History

api.invidious.io/

Build Status

Status page for Invidious instances, sourced from the documentation.

Installation

$ git clone https://github.com/iv-org/instances-api
$ cd instances-api
$ shards install
$ crystal build src/instances.cr --release

Usage

$ ./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-api/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