Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cicirello/alpine-plus-plus
A lightweight Docker container for shell scripting with git and GNU tools on Alpine Linux
https://github.com/cicirello/alpine-plus-plus
alpine alpine-linux bash coreutils docker-image findutils gawk git
Last synced: 14 days ago
JSON representation
A lightweight Docker container for shell scripting with git and GNU tools on Alpine Linux
- Host: GitHub
- URL: https://github.com/cicirello/alpine-plus-plus
- Owner: cicirello
- License: mit
- Created: 2020-08-30T18:38:18.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T21:06:22.000Z (about 2 months ago)
- Last Synced: 2024-10-10T20:21:09.529Z (28 days ago)
- Topics: alpine, alpine-linux, bash, coreutils, docker-image, findutils, gawk, git
- Language: Dockerfile
- Homepage: https://actions.cicirello.org/alpine-plus-plus/
- Size: 140 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# alpine-plus-plus
[](#alpine-plus-plus)
Website for our GitHub Actions and tools for developing them: https://actions.cicirello.org/
| __Docker Hub__ | [](https://hub.docker.com/r/cicirello/alpine-plus-plus) [](https://hub.docker.com/r/cicirello/alpine-plus-plus) |
| :--- | :--- |
| __GitHub__ | [](https://github.com/cicirello/alpine-plus-plus/releases) |
| __Image Stats__ | [](https://hub.docker.com/r/cicirello/alpine-plus-plus) |
| __Build Status__ | [](https://github.com/cicirello/alpine-plus-plus/actions/workflows/docker-image.yml) |
| __License__ | [](https://github.com/cicirello/alpine-plus-plus/blob/master/LICENSE) |
| __Support__ | [](https://github.com/sponsors/cicirello) [](https://liberapay.com/cicirello) [](https://ko-fi.com/cicirello) |
## Summary
The alpine-plus-plus Docker image is motivated by
Github-actions implemented primarily with bash
and shell utilities, but is also potentially
applicable to any use-case where you primarily
need bash and GNU tools like gawk, etc, as well
as git, but also want to keep the image size
relatively small. Alpine Linux is used as the base
image. Alone, Alpine almost suits this purpose.
However, it lacks the bash shell, and commonly
used GNU tools such as findutils, gawk, etc. It
also lacks git. The alpine-plus-plus image adds
git, bash, findutils, coreutils, and gawk on top
of Alpine Linux.
For more information, see my blog post on DEV: [gnu-on-alpine and alpine-plus-plus: Two Lightweight Containers for Implementing GitHub Container Actions with Shell Scripting](https://dev.to/cicirello/gnu-on-alpine-and-alpine-plus-plus-two-lightweight-containers-for-implementing-github-container-actions-with-shell-scripting-360i).
## Multiplatform Image
alpine-plus-plus has the following platforms available:
* linux/386
* linux/amd64
* linux/arm/v6
* linux/arm/v7
* linux/arm64
* linux/ppc64le
* linux/s390x
## Source Repository and Builds
The [source repository](https://github.com/cicirello/alpine-plus-plus) is maintained on GitHub. The images are built on Github and pushed to [Docker Hub](https://hub.docker.com/r/cicirello/alpine-plus-plus), as well as the [Github Container Registry](https://github.com/cicirello?ecosystem=container&tab=packages) using Github Actions.
## Docker Tags and Versioning Scheme
Each image pushed to Docker Hub and the Github Container Registry is tagged as follows:
* The tag `latest` indicates, well, the latest image.
* Tags of the form MAJOR.MINOR.PATCH (such as 3.13.5) indicate the SemVer of
the __Alpine__ image used as the base.
* Tags of the form MAJOR.MINOR (e.g., 3.13) correspond to the most recent patch level of
the __Alpine__ image used as the base. For example, if 3.13.5 is the latest
release, then 3.13 maps to this as well.
* Tags of the form MAJOR (e.g., 3) correspond to the most recent patch level of
the __Alpine__ image used as the base, with major corresponding major version.
For example, if 3.13.5 is the latest release, then 3 maps to this as well.
[Semantic Versioning](https://semver.org/) uses version numbers
of the form: MAJOR.MINOR.PATCH, where differences in
MAJOR correspond to incompatible changes, differences in MINOR
correspond to introduction of backwards compatible new functionality,
and PATCH corresponds to backwards compatible bug fixes.
## Installation and Usage
The pre-built image is hosted on both Docker Hub and the Github Container Registry. You can use it in the following ways.
### Docker Pull Command
Pull the latest image from Docker Hub with the following (replace `latest` with
a specific version number if you prefer):
```
docker pull cicirello/alpine-plus-plus:latest
```
Pull from the Github Container Registry with:
```
docker pull ghcr.io/cicirello/alpine-plus-plus:latest
```
### Use as a base image in a Dockerfile
Use as a base image in a Dockerfile (replace `latest` with
a specific version number if you prefer):
```Dockerfile
FROM cicirello/alpine-plus-plus:latest
# The rest of your Dockerfile would go here.
```
Or you can use as a base image (via the Github Container Registry) with:
```Dockerfile
FROM ghcr.io/cicirello/alpine-plus-plus:latest
# The rest of your Dockerfile would go here.
```
A specific example usage can be found in the [Dockerfile
of the generate-sitemap Github
action](https://github.com/cicirello/generate-sitemap/blob/master/Dockerfile).
## License
### Source Code License
The source code, including the Dockerfile and anything
else within the [Github repository for alpine-plus-plus](https://github.com/cicirello/alpine-plus-plus), is licensed under the
[MIT License](https://github.com/cicirello/alpine-plus-plus/blob/master/LICENSE).
### Image Licenses
As with all pre-built Docker images, the image itself (once built, or obtained from
Docker Hub or the Github Container Registry) contains software that is covered by a
variety of licenses. Since the base image is Alpine, this would include
the [licenses of the components of Alpine](https://pkgs.alpinelinux.org/);
and also includes the [licenses of the GNU tools added to the image](https://www.gnu.org/licenses/gpl-3.0.en.html)
and the [license for git](https://git-scm.com/).
If you build and distribute an image containing your software,
using alpine-plus-plus as the base image, it
is your responsibility to follow the licenses of all of the
software contained within the image. At the time that this documentation
is written, one of the effects of the combination of those licenses is
a constraint on the licensing of such a pre-built image containing
your software to the GPL 3.0 or later (derived from the inclusion of bash
and the other GNU tools). If you desire a more permissive license
for your software, one approach would be to instead distribute a
Dockerfile that builds the image containing your software,
rather than a pre-built image of your software, which should circumvent the
issue since you would no longer be distributing a derivative of
GPL licensed software.