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

Provide better docs for Sourcify #21

Open
wmitsuda opened this issue Sep 27, 2024 · 4 comments · May be fixed by #22
Open

Provide better docs for Sourcify #21

wmitsuda opened this issue Sep 27, 2024 · 4 comments · May be fixed by #22
Assignees
Labels
enhancement New feature or request

Comments

@wmitsuda
Copy link
Member

I think we should now provide a proper documentation for using Otterscan + Sourcify using the repo v2 format (while we don't have/find a good way to run it from parquet files)

maybe some copy/pastable example of downloading the 30GB (200GB unpacked) + one liner CLI to serve directory + otterscan config to wire that local server?

and delete the other methods that are not feasible anymore, hence supporting only central repo v1 server and filesystem download repo v2.

@sealer3
Copy link
Collaborator

sealer3 commented Sep 27, 2024

Do you mean we should also remove IPFS support since by default it provides few benefits? We should have an issue on the main repo too.

The other method that's not feasible anymore, which I will remove, is the outdated section for an Otterscan-provided Local snapshot.

@sealer3 sealer3 linked a pull request Sep 29, 2024 that will close this issue
@wmitsuda
Copy link
Member Author

wmitsuda commented Oct 3, 2024

Last time I tried, the IPNS was not working, that + let's say IPNS was working, one would want to pin it locally for faster access, but it would take ages to download everything via IPFS.

I'm inclined to remove this option and only support "central sourcify server" and "download filesystem V2" (+good docs for downloading the whole package and setting up the config on otterscan)

WDYT?

@wmitsuda
Copy link
Member Author

wmitsuda commented Oct 3, 2024

ah yes, and "local snapshot" does not make sense anymore if sourcify themselves now produce daily tar.gz of everything.

@sealer3
Copy link
Collaborator

sealer3 commented Oct 4, 2024

I'm inclined to remove the IPNS support, too. Should we support multiple Sourcify sources (switcher could still be used if more than one source is configured) or remove the switcher altogether? Using a local repo but also having the ability to switch to the main Sourcify repository would be the primary use case for keeping a switcher.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants