Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
viktorianer committed Oct 2, 2024
1 parent c0b1912 commit abea510
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/apt/NOTES.md
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.
42 changes: 42 additions & 0 deletions src/apt/README.md
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
```

0 comments on commit abea510

Please sign in to comment.