yogsototh/leiningen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs update for changes to resolution of repository credentials (gh-768)

Browse source
This commit is contained in:
Chas Emerick 2012-10-05 06:26:50 -04:00
parent b06a04593a
commit 102dcadf9f
1 changed files with 27 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
doc/DEPLOY.md
View file

@ -54,13 +54,13 @@ set up credentials, but it's convenient to set it so you don't have to
re-enter it every time you want to deploy. You will need
[gpg](http://www.gnupg.org/) installed and a key pair configured.
If you specify `:gpg` in one of your `:repositories` settings maps,
Leiningen will decrypt `~/.lein/credentials.clj.gpg` and use that to
find the proper credentials for the given repository.
If you specify a `:creds :gpg` entry in one of your `:repositories` settings
maps, Leiningen will decrypt `~/.lein/credentials.clj.gpg` and use that to find
the proper credentials for the given repository.
```clj
:repositories [["releases" {:url "http://blueant.com/archiva/internal"
:username "milgrim" :password :gpg}]]
:creds :gpg}]]
```
First write your credentials map to `~/.lein/credentials.clj` like so:
@ -102,6 +102,29 @@ Unattended builds can specify `:env` instead of `:gpg` in the
repository specification to have credentials looked up in the
environment. For example, specifying `:password :env` will cause
Leiningen to look up `(System/getenv "LEIN_PASSWORD")` for that value.
You can control which environment variable is looked up for each value
by using a namespaced keyword, like so:
```clj
:repositories [["releases" {:url "http://blueant.com/archiva/internal"
:username :env/archiva_username
:passphrase :env/archiva_passphrase}]]
```
Finally, you can opt to load credentials from the environment _or_ GPG credentials
by using a vector of `:gpg` and `:env/*` values to define the priority of each:
```clj
:repositories [["releases" {:url "http://blueant.com/archiva/internal"
:username [:gpg :env/archiva_username]
:passphrase [:gpg :env/archiva_passphrase]}]]
```
In this example, both `:username` and `:password` will be looked up in
`~/.lein/credentials.clj.gpg` first, and only if a value is not available there will
the `ARCHIVA_*` env vars be checked. This allows you to avoid creating profiles
just to use different credential sources in e.g. a local development environment
vs. a centralized build environment.
## Deployment