documented encrypted variables

This commit is contained in:
Brad Rydzewski 2015-08-20 12:42:13 -07:00
parent a0cbba5a95
commit 407feaaeba
2 changed files with 7 additions and 2 deletions

View file

@ -21,7 +21,7 @@ Contributions, questions, and comments are welcomed and encouraged. Drone develo
### Cloning, Building, Running ### Cloning, Building, Running
If you are new to Go, make sure you [install](http://golang.org/doc/install) Go 1.4+ and [setup](http://golang.org/doc/code.html) your workspace (ie `$GOPATH`). Go programs use directory structure for package imports, therefore, it is very important you clone this project to the specified directory in your Go path: If you are new to Go, make sure you [install](http://golang.org/doc/install) Go 1.5+ and [setup](http://golang.org/doc/code.html) your workspace (ie `$GOPATH`). Go programs use directory structure for package imports, therefore, it is very important you clone this project to the specified directory in your Go path:
``` ```
git clone git://github.com/drone/drone.git $GOPATH/src/github.com/drone/drone git clone git://github.com/drone/drone.git $GOPATH/src/github.com/drone/drone

7
doc/build/env.md vendored
View file

@ -13,7 +13,9 @@ The build environment has access to the following environment variables:
## Private Variables ## Private Variables
Drone also lets you to store sensitive data external to the `.drone.yml` and inject at runtime. You can declare private variables in the repository settings screen. These variables are injected into the `.drone.yml` at runtime using the `$$` notation. You may also store encrypted, private variables in the `.drone.yml` and inject at runtime. Private variables are encrypted using RSA encryption with OAEP (see [EncryptOAEP](http://golang.org/pkg/crypto/rsa/#EncryptOAEP)). You can generate encrypted strings from your repository settings screen.
Once you have an ecrypted string, you can add to the `secure` section of the `.drone.yml`.These variables are decrypted and injected into the `.drone.yml` at runtime using the `$$` notation.
An example `.drone.yml` expecting the `HEROKU_TOKEN` private variable: An example `.drone.yml` expecting the `HEROKU_TOKEN` private variable:
@ -29,4 +31,7 @@ deploy:
heroku: heroku:
app: pied_piper app: pied_piper
token: $$HEROKU_TOKEN token: $$HEROKU_TOKEN
secure:
HEROKU_TOKEN: <encrypted string>
``` ```