iv-org-mirror
/
instances-api
mirror of https://gitea.invidious.io/iv-org/instances-api.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
67 Commits 6 Branches 0 Tags 202 KiB
Crystal 54.3%
HTML 42%
Dockerfile 3.7%
Go to file
Émilien (perso) 58115dd0dc
remove pull request mention (#51) 
* remove pull request mention

* better wording

Co-authored-by: syeopite <70992037+syeopite@users.noreply.github.com>

---------

Co-authored-by: syeopite <70992037+syeopite@users.noreply.github.com>
 		2024-04-28 12:52:00 +02:00
.github/workflows update crystal version + shards lib (#48) 2024-04-21 21:36:03 +02:00
assets/css Initial commit 2019-09-04 20:55:33 -04:00
spec Initial commit 2019-09-04 20:55:33 -04:00
src remove pull request mention (#51) 2024-04-28 12:52:00 +02:00
.editorconfig Initial commit 2019-09-04 20:55:33 -04:00
.gitignore Track shards and drop travis 2021-01-07 20:56:14 +01:00
Dockerfile update crystal version + shards lib (#48) 2024-04-21 21:36:03 +02:00
LICENSE Initial commit 2019-09-04 20:55:33 -04:00
README.md Update the README 2021-08-10 16:45:51 +02:00
docker-compose.yml Add container and CI 2021-01-07 13:20:18 +01:00
shard.lock update crystal version + shards lib (#48) 2024-04-21 21:36:03 +02:00
shard.yml update crystal version + shards lib (#48) 2024-04-21 21:36:03 +02:00

README.md

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