webosbrew/webos-homebrew-channel

Host custom repository

gibahjoe opened this issue · 1 comments

How can I find the guide to host a custom repo?

I see in the settings you can add a custom repo. But I can't find a guide to set it up. Or is this not suppirted? I assume the repositories will be hosted in github.

"webosbrew repository" is essentially an URL responding with a JSON file matching the following schema:
https://github.com/webosbrew/docs/blob/main/schemas/HomebrewRepository.schema.json

Example repository is available here: https://github.com/webosbrew/docs/blob/main/test/repo.json
Official webosbrew apps repo: https://repo.webosbrew.org/api/apps.json

Some things are underspecified in the schema:

  • All URLs can be relative, and will be resolved relative to repository URL
  • It's preferred to expose manifest key, though it is only supported since Homebrew Channel v0.3.0 - passing both manifestUrl and manifest is technically valid.
  • paging key present in example repository files is currently unsupported by Homebrew Channel - all apps need to be returned on a single page/request.
  • If you need/want you can freely reuse our existing tooling and infrastructure since it's been released on Apache 2.0 license.

We've got to add a minimal guide/description of webosbrew repository schema on webosbrew.org, thanks for reminding... :)