Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Host custom repository #133

Open
gibahjoe opened this issue Jan 22, 2023 · 1 comment
Open

Host custom repository #133

gibahjoe opened this issue Jan 22, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@gibahjoe
Copy link

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.

@Informatic
Copy link
Member

Informatic commented Jan 22, 2023

"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... :)

@throwaway96 throwaway96 added the documentation Improvements or additions to documentation label Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants