Boxfuse Deployment

This page documents deployments using dpl v1 which is currently the legacy version. The dpl v2 is released, and we recommend useig it. Please see our blog post for details. dpl v2 documentation can be found here.

Travis CI can automatically deploy your Boxfuse application after a successful build.

For a minimal configuration, all you need to do is add the following to your .travis.yml:

deploy:
  provider: boxfuse
  user: "YOUR BOXFUSE CLIENT USER"
  secret: "YOUR BOXFUSE CLIENT SECRET"
  payload: "YOUR APPLICATION ARTIFACT (typically a jar, war, tar.gz or zip file)"

We recommended that you encrypt your Boxfuse user and secret. Assuming you have the Travis CI command line client installed, you can do it like this (you will be prompted for values on the command line):

travis encrypt --add deploy.user
travis encrypt --add deploy.secret

Alternatively, you can pass in your credentials using Travis CI encrypted environment variables called BOXFUSE_USER and BOXFUSE_SECRET. You can define these variables either using the Travis CI command line client or directly in the Travis CI repository settings UI.

Finally you can also fully configure Boxfuse by placing a boxfuse.conf file in the root of your repository. More info about configuration in the Boxfuse Command-line Client documentation.

Specify the Boxfuse app and image version #

By default Boxfuse will detect the app and the version automatically from the name of your payload file. You can override this like this:

deploy:
  provider: boxfuse
  user: "YOUR BOXFUSE CLIENT USER"
  secret: "YOUR BOXFUSE CLIENT SECRET"
  payload: "YOUR APPLICATION ARTIFACT (typically a jar, war, tar.gz or zip file)"
  image: "YOUR BOXFUSE APP AND VERSION (ex.: myapp:1.23)"

You can also use Travis CI environment variables like TRAVIS_BUILD_NUMBER to assign a version to the image. Ex.: image: "myapp:$TRAVIS_BUILD_NUMBER"

Specify the Boxfuse Environment #

By default, Boxfuse will deploy to your test environment. You can override this like this:

deploy:
  provider: boxfuse
  user: "YOUR BOXFUSE CLIENT USER"
  secret: "YOUR BOXFUSE CLIENT SECRET"
  payload: "YOUR APPLICATION ARTIFACT (typically a jar, war, tar.gz or zip file)"
  env: "YOUR BOXFUSE ENVIRONMENT (default: test)"

Alternative configuration files #

You can also fully configure Boxfuse by placing a boxfuse.conf file in the root of your repository. You can specify an alternative configuration file like this:

deploy:
  provider: boxfuse
  configfile: "YOUR BOXFUSE CONFIGURATION FILE"

Specify custom arguments #

If the Boxfuse Client functionality you need is not included here, you can pass additional arguments to the Boxfuse executable by using the extra_args parameter:

deploy:
  provider: boxfuse
  extra_args: "YOUR EXTRA ARGS (ex.: -X)"

Further information #

Go to the Boxfuse website to learn more about Boxfuse and how to configure it.