https://github.com/kool-dev/docker-java
https://github.com/kool-dev/docker-java
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kool-dev/docker-java
- Owner: kool-dev
- License: mit
- Created: 2020-10-28T00:51:38.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-10T01:57:25.000Z (almost 3 years ago)
- Last Synced: 2025-01-24T08:43:31.288Z (11 months ago)
- Language: Dockerfile
- Size: 66.4 KB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Description
Minimal Java Docker image focused on Java applications based on [Amazon Corretto](https://github.com/corretto/corretto-docker). It's use is intended for [kool.dev](https://github.com/kool-dev/kool), but can fit in any other Java use-case.
Automatically load classpath in applications using **maven** or **gradle** architecture.
## Available Tags
The image built is [`kooldev/java`](https://hub.docker.com/r/kooldev/java/tags?page=1&ordering=last_updated) which has a bunch of tags available:
### 16
- [16](https://github.com/kool-dev/docker-java/blob/master/16/Dockerfile)
- [16-prod](https://github.com/kool-dev/docker-java/blob/master/16-prod/Dockerfile)
### 15
- [15](https://github.com/kool-dev/docker-java/blob/master/15/Dockerfile)
- [15-prod](https://github.com/kool-dev/docker-java/blob/master/15-prod/Dockerfile)
### 11
- [11](https://github.com/kool-dev/docker-java/blob/master/11/Dockerfile)
- [11-prod](https://github.com/kool-dev/docker-java/blob/master/11-prod/Dockerfile)
### 8
- [8](https://github.com/kool-dev/docker-java/blob/master/8/Dockerfile)
- [8-prod](https://github.com/kool-dev/docker-java/blob/master/8-prod/Dockerfile)
## Environment Variables
Variable | Default Value | Description
--- | --- | ---
**ASUSER** | `0` | Changes the user id that executes the commands
**UID** | `0` | Changes the user id that executes the commands **(ignored if ASUSER is provided)**
**VM_OPTIONS_XMS** | `256m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_XMX** | `256m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_MAX_METASPACE_SIZE** | `256m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_PERM_SIZE** | `512m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_XMN** | `64m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_SURVIVOR_RATIO** | `128` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**CMS_TRIGGER_PERCENT** | `70` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**JVM_FILE_ENCODING** | `UTF-8` | See [Java Documentations](https://docs.oracle.com/javame/config/cdc/cdc-opt-impl/ojmeec/1.0/runtime/html/localization.htm)
**JVM_TTL** | `60` | See [Java Documentations](https://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html)
**JVM_USER_LANGUAGE** | `en` | See [Java Documentations](https://docs.oracle.com/javame/config/cdc/cdc-opt-impl/ojmeec/1.0/runtime/html/localization.htm)
**JVM_USER_COUNTRY** | `US` | See [Java Documentations](https://docs.oracle.com/javame/config/cdc/cdc-opt-impl/ojmeec/1.0/runtime/html/localization.htm)
**TZ** | | Set default Timezone
**JAVA_OPTIONS** | | Additional Java Options
**RMI_SERVER_HOSTNAME** | | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/guides/rmi/javarmiproperties.html)
**JVM_JMXREMOTE_PORT** | | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html)
**JVM_JMXREMOTE_AUTHENTICATE** | | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html)
**JVM_JMXREMOTE_SSL** | | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html)
**DEBUG_PORT** | `9000` | Debug port
**DEBUG_SUSPEND** | `n` | Suspend debug to waiting attached
**CLASSPATH** | | Custom classpath, bay default defined by **maven** or **gradle** architecture
**MAIN_CLASS** | | Class main, required by execute
### PROD
Variable | Default Value | Description
--- | --- | ---
**ASUSER** | `0` | Changes the user id that executes the commands
**UID** | `0` | Changes the user id that executes the commands **(ignored if ASUSER is provided)**
**VM_OPTIONS_XMS** | `256m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_XMX** | `256m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_MAX_METASPACE_SIZE** | `256m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_PERM_SIZE** | `512m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_XMN** | `64m` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**VM_OPTIONS_SURVIVOR_RATIO** | `128` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**CMS_TRIGGER_PERCENT** | `70` | See [Java Documentations](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/java.html)
**JVM_FILE_ENCODING** | `UTF-8` | See [Java Documentations](https://docs.oracle.com/javame/config/cdc/cdc-opt-impl/ojmeec/1.0/runtime/html/localization.htm)
**JVM_TTL** | `60` | See [Java Documentations](https://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html)
**JVM_USER_LANGUAGE** | `en` | See [Java Documentations](https://docs.oracle.com/javame/config/cdc/cdc-opt-impl/ojmeec/1.0/runtime/html/localization.htm)
**JVM_USER_COUNTRY** | `US` | See [Java Documentations](https://docs.oracle.com/javame/config/cdc/cdc-opt-impl/ojmeec/1.0/runtime/html/localization.htm)
**TZ** | | Set default Timezone
**JAVA_OPTIONS** | | Additional Java Options
**JAR_FILE** | `/app/application.jar` | Jar file you application
## Usage
The developer version, you need mount your volume to maven and gradle.
- $HOME/.kool/m2:/home/kool/.m2
- $HOME/.kool/gradle:/home/kool/.gradle
### With `kool`:
In your application directory:
```shell
kool docker -e MAIN_CLASS=your.package.MainClass kooldev/java:8
```
To production version:
```shell
kool docker -e JAR_FILE=yout_application.jar kooldev/java:8-prod
```
Execute Jshell:
```shell
kool docker kooldev/java:11 jshell
```
### With `docker run`:
```sh
docker run -it --rm kooldev/java:11 jshell
```
### With `docker-compose.yml`:
```yaml
app:
image: kooldev/java:8
volumes:
- ".:/app:cached"
- "$HOME/.ssh/id_rsa:/home/developer/.ssh/id_rsa:cached"
environment:
ASUSER: "${$UID}"
```
## Contributing
### Update images with templates
You should change `fwd-template.json` for configuration and `template` folder for the actual base templates.
After any changes, we need to run `kool run template` to parse the templates and generate all versions folder/files.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.