https://github.com/bkahlert/build-runner
Multiplatform Alpine based SSH accessible Docker image with Docker CLI and OpenJDK 11 installed
https://github.com/bkahlert/build-runner
docker docker-image java ssh
Last synced: 4 months ago
JSON representation
Multiplatform Alpine based SSH accessible Docker image with Docker CLI and OpenJDK 11 installed
- Host: GitHub
- URL: https://github.com/bkahlert/build-runner
- Owner: bkahlert
- License: mit
- Created: 2021-09-19T00:15:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-05T17:58:01.000Z (about 2 years ago)
- Last Synced: 2024-12-28T15:38:45.349Z (6 months ago)
- Topics: docker, docker-image, java, ssh
- Language: Shell
- Homepage:
- Size: 88.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# bkahlert/build-runner [](https://github.com/bkahlert/build-runner/actions/workflows/build.yml) [](https://github.com/bkahlert/build-runner) [](https://github.com/bkahlert/build-runner/blob/master/LICENSE)
## About
**bkahlert/build-runner** is a multiplatform Alpine based SSH accessible Docker image with Docker CLI and OpenJDK 11 installed. It is compatible with IntelliJ
IDEA [run targets feature](https://www.jetbrains.com/help/idea/run-targets.html#target-types).
[
*SSH connection to a running instance of bkahlert/build-runner*](../../raw/master/docs/ssh.svg)
## Build locally
```shell
git clone https://github.com/bkahlert/build-runner.git
cd build-runner
# Build image and output to docker (default)
docker buildx bake
# Build multi-platform image
docker buildx bake image-all
```
## Image
* [Docker Hub](https://hub.docker.com/r/bkahlert/build-runner/) `bkahlert/build-runner`
* [GitHub Container Registry](https://github.com/users/bkahlert/packages/container/package/build-runner) `ghcr.io/bkahlert/build-runner`
Following platforms for this image are available:
* linux/amd64
* linux/arm64/v8
## Usage
### Run as an application
If you pass arguments to the container, they will be treated like a regular command line. The container will run the command line and terminate.
```shell
docker run --rm -it \
-v "$(pwd):$(pwd)" \
-w "$(pwd)" \
bkahlert/build-runner:edge \
javac --version
```
### Run as a service / SSH server
Starting the container without any arguments will launch an SSH server that will listen for connections.
By default, authentication uses public key. Since no public key is provided in the `bkahlert/build-runner`,
a public key must be provided at startup:
```shell
# start container
docker run -d --rm \
-e AUTHORIZED_KEYS="$(cat ~/.ssh/id_rsa.pub)" \
-v "$(pwd):$(pwd)" \
-w "$(pwd)" \
-p 2022:2022 \
"build-runner:edge"
# connect
ssh \
-i ~/.ssh/id_rsa \
-o StrictHostKeyChecking=no \
-o UserKnownHostsFile=/dev/null \
-o LogLevel=ERROR \
-p 2022 \
"runner@localhost" \
id
```
Alternatively a password can be provided which enables password and disables public key authentication:
```shell
# start container
docker run -d --rm \
-e PASSWORD=pass1234 \
-v "$(pwd):$(pwd)" \
-w "$(pwd)" \
-p 2022:2022 \
"build-runner:edge"
# connect
sshpass -p "pass1234" ssh \
-o StrictHostKeyChecking=no \
-o UserKnownHostsFile=/dev/null \
-o LogLevel=ERROR \
-p 2022 \
"runner@localhost" \
id
```
See [configuration](#configuration) to set the public key or password during build time.
## Configuration
This image can be configured using the following options of which all but `APP_USER` and `APP_GROUP` exist as both—build argument and environment variable.
You should go for build arguments if you want to set custom defaults you don't intend to change (often). Environment variables will overrule any existing
configuration on each container start.
- `APP_USER` Name of the main user (default: `runner`)
- `APP_GROUP` Name of the main user's group (default: `runner`)
- `DEBUG` Whether to log debug information (default: `0`)
- `TZ` Timezone the container runs in (default: `UTC`)
- `LANG` Language/locale to use (default: `C.UTF-8`)
- `PUID` User ID of the `runner` user (default: `1000`)
- `PGID` Group ID of the `runner` group (default: `1000`)
- `AUTHORIZED_KEYS` Public key(s) that can be used to log in via SSH as `runner`
- `PASSWORD` Password of `runner` (default: `runner`)
> 🔐 Specifying authorized key(s) will automatically disable password-based authentication. An eventually also configured password will be ignored.
> Setting authorized key(s) to an empty string, will re-enable the password-based authentication with either the provided or otherwise a randomly generated password.
```shell
# Build single image with build argument AUTHORIZED_KEYS
docker buildx bake --set "*.args.AUTHORIZED_KEYS=$(cat ~/.ssh/id_rsa.pub)"
# Build multi-platform image with build argument AUTHORIZED_KEYS
docker buildx bake image-all --set "*.args.AUTHORIZED_KEYS=$(cat ~/.ssh/id_rsa.pub)"
# Start container with environment variable AUTHORIZED_KEYS
docker run --rm \
-e AUTHORIZED_KEYS="$(cat ~/.ssh/id_rsa.pub)" \
-v "$(pwd):$(pwd)" \
-w "$(pwd)" \
-p 2022:2022 \
build-runner:local
```
## Testing
```shell
git clone https://github.com/bkahlert/build-runner.git
cd build-runner
# Use Bats wrapper to run tests
curl -LfsS https://git.io/batsw \
| DOCKER_BAKE="--set '*.tags=test'" "$SHELL" -s -- --batsw:-e --batsw:BUILD_TAG=test test
```
[Bats Wrapper](https://github.com/bkahlert/bats-wrapper) is a self-contained wrapper to run tests based on the Bash testing
framework [Bats](https://github.com/bats-core/bats-core).
> 💡 To accelerate testing, the Bats Wrapper checks if any test is prefixed with a capital X and if so, only runs those tests.
## Troubleshooting
- To avoid permission problems with generated files, you can use your local user/group ID (see `PUID`/`PGID`).
- If you need access to Docker, its command line interface is already installed.
You can control your host instance by mounting `/var/run/docker.sock`.
```shell
docker run -it --rm \
-e PUID="$(id -u)" \
-e PGID="$(id -g)" \
-v /var/run/docker.sock:/var/run/docker.sock \
-v "$PWD":"$PWD" \
-w "$PWD" \
bkahlert/build-runner:edge
```
## Contributing
Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. You can also support this project by making
a [PayPal donation](https://www.paypal.me/bkahlert) to ensure this journey continues indefinitely!
Thanks again for your support, it is much appreciated! :pray:
## License
MIT. See [LICENSE](LICENSE) for more details.