search

conan-io / docs

conan.io reStructuredText documentation
http://docs.conan.io
MIT License
104 stars 352 forks source link

[question] Request for docs: conan_server StorageAdapter #2701

Open knzivid opened 2 years ago

knzivid commented 2 years ago

https://docs.conan.io/en/latest/uploading_packages/running_your_server.html mentions

Conan has implemented an extensible storage backend based on the abstract class StorageAdapter. Currently, the server only supports storage on disk. The folder in which the uploaded packages are stored (i.e., the folder you would want to backup) is defined in the disk_storage_path.

Where can I find more documentation on the StorageAdapter interface? I did not find it in the source under https://github.com/conan-io/conan/tree/develop/conans/server/store.

Any help is appreciated :)

memsharded commented 2 years ago

This is an issue for the docs, transferring it to the right repo.

memsharded commented 2 years ago

There is no documentation for the StorageAdapter, and I think documenting such parts of the code explicitly will be unlikely a priority in the short term, we still have lots of document of much more urgent parts, specially 2.0.

The current implementation of this Adapter is ServerDiskAdapter, and it is only around 90 lines of relatively straightforward code, so I would recommend having a look at the code directly.