anatol / pacoloco

Caching proxy server for Arch Linux pacman
MIT License
216 stars 30 forks source link

Simplify default pacoloco.yaml config #81

Closed ericlay closed 1 year ago

ericlay commented 1 year ago

I found it a little confusing to have the optional repositories included in the installed config file pacoloco.yaml

 quarry:
    url: http://pkgbuild.com/~anatolik/quarry/x86_64
 sublime:
    url: https://download.sublimetext.com/arch/stable/x86_64

It is not noted in the configuration section that these are purely optional. And possibly lead those who are unaware to have unused extra repositories configured.

Arch wiki has a sample config that is a lot more bare bones.

port: 9129
repos:
  mycopy:
    urls:
      - http://mirror.lty.me/archlinux
      - http://mirrors.kernel.org/archlinux

IMO moving the sample config as is to /usr/share and documenting both the optional repositories as well the need to edit/move/recreate the file in /etc would be a more appropriate method.

At minimum, please signify that these are purely optional repositories and are not needed to function somewhere in the configuration section?

anatol commented 1 year ago

Thank you for filing this issue.

Historically pacoloco.yaml.sample is served as a showcase for the pacoloco features and included a lot of stuff that is rarely needed for a user. To some degree the sample file duplicates information already mentioned at README.

From other side the sample file is also used as a default config for the Arch package. And as you said it is a good idea to keep is simple and clean. I am fine with dropping all the confusing options from pacoloco.yaml.sample. Do you mind to send a PR for it?

ericlay commented 1 year ago

I can see the value in both sides as well. I have made a PR here. I think it's wise to keep options in the default config with the optional ones commented out. It serves as a good example, imo. I tried to keep things intact and just provide some slight guidance/explanation. Hope this is useful! :)

anatol commented 1 year ago

Closed with #83