bleep icon indicating copy to clipboard operation
bleep copied to clipboard

Documentation on authentication missing

Open kluen opened this issue 2 years ago • 7 comments

In order to use authentication for URLs configured in resolvers, one needs to create a config file. By looking through the code[^easy] I found that https://github.com/dirs-dev/directories-jvm is used and that on my macOS machine I had to create a ~/Library/Application Support/build.bleep.bleep/config.yaml with the following contents:

authentications:
  <some-resolver-url>:
    user: <the-user>
    password: <the-password>

compileServerMode: 
  mode: shared

It would be great if this was documented on the website to lower the barrier for people trying out Bleep.

[^easy]: Btw. I found it relatively easy to do, thanks for the clean code base!

kluen avatar Dec 30 '22 13:12 kluen

Absolutely! linking this to #243 so I won't forget :)

oyvindberg avatar Dec 30 '22 21:12 oyvindberg

The config file should now be put in ~/Library/Application Support/build.bleep/config.yaml

olivierdeckers avatar Jul 31 '23 16:07 olivierdeckers

@olivierdeckers hmm, WDYM shouldn't be put there?

I notice that the instructions at the top here have the old path pattern for the config file @ngbinh, you can run bleep config file to see the expected path on your system. might that have caused the problems you were seeing in #347 ?

oyvindberg avatar Aug 01 '23 02:08 oyvindberg

@oyvindberg that's a good point. I will try it again today. But to make sure I get it right, do you have a fully working configuration? I am not sure if I should put the https part in the url and should I use double quotes on the user and password.

ngbinh avatar Aug 01 '23 02:08 ngbinh

authentications:
  https://artifactory.flaff.com:
    user: username
    password: password

oyvindberg avatar Aug 01 '23 02:08 oyvindberg

I meant now instead of not, sorry for the unfortunate typo ;)

olivierdeckers avatar Aug 01 '23 04:08 olivierdeckers

Another thing about this authentication: it's been my intention that people not edit this config file themselves, but use commands bleep config ... to change it. If any of you want an easy entrance into contributing this is a super place to start

oyvindberg avatar Aug 01 '23 07:08 oyvindberg