https://github.com/gregwhitaker/envopts

Parses an environment variable into Java system parameters
https://github.com/gregwhitaker/envopts

docker environment-variables system-properties

Last synced: about 1 month ago
JSON representation

Parses an environment variable into Java system parameters

• Host: GitHub
• URL: https://github.com/gregwhitaker/envopts
• Owner: gregwhitaker
• License: mit
• Created: 2020-03-21T00:22:22.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-21T23:11:59.000Z (about 6 years ago)
• Last Synced: 2025-02-25T17:41:34.743Z (over 1 year ago)
• Topics: docker, environment-variables, system-properties
• Language: Java
• Homepage:
• Size: 82 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# envopts

[![Build Status](https://travis-ci.org/gregwhitaker/envopts.svg?branch=master)](https://travis-ci.org/gregwhitaker/envopts)

Parses an environment variable containing multiple system properties and sets the properties for use in a Java application.

This is useful for when you want to supply a bunch of system properties to a Docker container.

## Importing

The library is available on [BinTray JCenter](https://bintray.com/gregwhitaker/maven/envopts):

* Maven

        

            com.github.gregwhitaker

            envopts

            1.0.0

        

        

* Gradle

        implementation 'com.github.gregwhitaker:envopts:1.0.0'

## Usage

Simply supply an environment variable named `ENV_OPTS` with a comma-delimited string of system properties you would like

to set on the JVM:

    ENV_OPTS=-Dspring.profiles.active='local,dev',-Dlog4j.configurationFile=log4j2.xml

    

Then in your application startup add the following:

    EnvOpts.parse();

    

Once the environment variable is parsed you will be able to access the system properties like so:

    System.getProperty("spring.profiles.active")

    

## Examples

Please see the example projects below for demonstrations on how to use envopts in different environments:

* [Docker](https://github.com/gregwhitaker/envopts-springboot-example) - Example of using envopts in a Spring Boot application packaged as a Docker container.

## Building from Source

Run the following command to build EnvOpts from source:

    ./gradlew clean build

## Bugs and Feedback

For bugs, questions, and discussions please use the [Github Issues](https://github.com/gregwhitaker/envopts/issues).

## License

MIT License

Copyright (c) 2020 Greg Whitaker

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.