-
Notifications
You must be signed in to change notification settings - Fork 386
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c0b1912
commit abea510
Showing
2 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# OS Support | ||
|
||
This feature supports recent versions of Debian and Ubuntu distributions with the `apt` package manager. It works with any base image using these distributions, like `ubuntu:focal` or `debian:buster`. | ||
|
||
`bash` is required to execute the `install.sh` script. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Aptfile Dependencies (apt) | ||
|
||
Install apt dependencies defined in an `Aptfile.dev` file. This feature is inspired by the approach found in [heroku-buildpack-apt](https://github.com/heroku/heroku-buildpack-apt) and [Aptfile Buildpack on App Platform](https://docs.digitalocean.com/products/app-platform/reference/buildpacks/aptfile/). It simplifies the process of managing and installing apt packages required for a development environment by specifying them in one file. | ||
|
||
## Example Usage | ||
|
||
```json | ||
"features": { | ||
"ghcr.io/viktorianer/features/apt:1": { | ||
"devFile": "../Aptfile.dev" | ||
} | ||
} | ||
``` | ||
|
||
## Options | ||
|
||
| Options Id | Description | Type | Default Value | | ||
|------------|-------------|--------|---------------| | ||
| devFile | Path to the Aptfile.dev file. This is where the list of apt packages is defined. | string | `../Aptfile.dev` | | ||
|
||
## How It Works | ||
|
||
- The feature reads the list of packages from the `Aptfile.dev` file and installs them during the container setup. | ||
- The default path is `Aptfile.dev`, but this can be customized using the `devFile` option. | ||
- It removes any commented or empty lines before installing the packages with `apt-get install`. | ||
|
||
Example `Aptfile.dev`: | ||
|
||
```bash | ||
# Video thumbnails | ||
ffmpeg | ||
libvips | ||
|
||
# PDF thumbnails | ||
poppler-utils | ||
# mupdf | ||
# mupdf-tools | ||
|
||
# PostgreSQL | ||
libpq-dev | ||
postgresql-client | ||
``` |