Configurable index location

[Nemo157]

To support a staging server and other users running their own docs.rs instance against their own registry the index repository used should be configurable.

[Nemo157]

Of course this is a bit more involved than I thought at first.

As well as changing the index this will need to:

1. Change the docbuilder to pull the crate to be built from the alternative registry.
2. Use the api key from the index to determine which API to hit for additional details, and deal with registries that do not support this API.

[jyn514]

Relevant code:

• https://github.com/rust-lang/docs.rs/blob/8fb139b/src/docbuilder/rustwide_builder.rs#L203
• https://docs.rs/rustwide/0.7.1/rustwide/struct.Crate.html#method.crates_io
• https://docs.rs/crate/rustwide/0.7.1/source/src/crates/cratesio.rs

This will require changes to rustwide.

[Nemo157]

I've got ~everything except the rustwide changes done in master...Nemo157:alternative-registry, though I'll likely split off some cleanup I've done there to make a small PR beforehand.

[repi]

This would be great to have!

We currently use a private crate registry on cloudsmith.io for crates that are private or not fully ready yet to be open sourced. EmbarkStudios/rust-ecosystem#47

[jyn514]

This would be great to have!

We currently use a private crate registry on cloudsmith.io for crates that are private or not fully ready yet to be open sourced. EmbarkStudios/rust-ecosystem#47

Note that this would still not allow using crates from a private registry on docs.rs. Rather, this allows you to host your own docs.rs instance which uses a private registry.

[repi]

Note that this would still not allow using crates from a private registry on docs.rs. Rather, this allows you to host your own docs.rs instance which uses a private registry.

Yes that makes sense 😀 and was my expectation & use case as well.

[Nemo157]

Another point to deal with here: authentication. Probably just needs documenting that the user account that docs.rs is running under must have a git credential helper setup correctly (I assume this works with libgit2 correctly? In my own alternative registry experiments I've had to use the net.git-fetch-with-cli option because libgit2 doesn't support the "dumb" http transport, but cloudsmith don't mention having to enable this for basic auth).

---

@repi from looking through your linked issues I see that cloudsmith support at least the subset of the crates.io API required for publishing. Do you know if there's any documentation on what other parts of the API they support? I can only find documentation on their own API, not on the package manager specific APIs. (We pull some other details from the crates.io API for each build).

---

Another-nother point, we link to crates.io in the templates. It is impossible to derive a correct url to link to for an arbitrary registry, so we probably want a separate config item for this (or 2, one to the homepage, one to create a url for each crate). For crates.io we'd get away with just a prefix we append the crate name to, though maybe it'd be better to take a template string that we insert the crate name into.

[repi]

@Nemo157 haven't seen any details of what part of the Cargo Registry API cloudsmith.io supports.

But @lskillen at cloudsmith should know and hopefully can help

[Kixiron]

There's some various decoupling that I need to do in templates, namely not making the https://docs.rs domain hard-coded, I can add in the registry changes as well, I can expose both via a Tera function