Skip to content

Commit 104c6bf

Browse files
committed
Updated with latest changes from dev
2 parents 3cc9bb8 + ba91955 commit 104c6bf

File tree

8 files changed

+37
-70
lines changed

8 files changed

+37
-70
lines changed

.github/workflows/ci-redcap-fastcgi-client.yaml

Lines changed: 0 additions & 18 deletions
This file was deleted.

.vscode/settings.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"cSpell.words": [
3+
"aphp",
4+
"Dockle",
5+
"edocs",
6+
"ghostscript",
7+
"imagick",
8+
"libfcgi",
9+
"logfile",
10+
"maxbytes",
11+
"mysqli",
12+
"rpcinterface",
13+
"shibd",
14+
"stopasgroup",
15+
"supervisord",
16+
"usecase"
17+
]
18+
}

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ Those images are as follow :
1212

1313
Each subfolder contains its own README file.
1414

15-
All those containers are `rootless`, and **none of them is containing, or distributing REDCap binairies**.
15+
All those containers are `rootless`, and **none of them is containing, or distributing REDCap binaries**.
1616
If you wish to use REDCap and are not sure where to start, you may visit the dedicated [REDCap Community Site](https://projectredcap.org/resources/community/).
1717

18-
## Continous Integration / Continous Delivery
18+
## continuous Integration / continuous Delivery
1919

20-
This project uses 3 Github Workflows (presents under the .github/workflows directory), which will, for each image :
20+
This project uses two Github Workflows (presents under the .github/workflows directory), which will, for each image :
2121
- Lint the Dockerfile using `Hadolint`
2222
- Scan the container images using `Dockle`
2323
- Runs critical vulnerability, secrets and license checks on the container image using `Trivy`
@@ -29,6 +29,6 @@ You're welcome to read the [contribution guidelines](./CONTRIBUTING.md).
2929

3030
## How is this project licensed?
3131

32-
The informations about the licensing and the dependencies of this project can be found under :
32+
The information about the licensing and the dependencies of this project can be found under :
3333
- The [project's license file](./LICENSE)
3434
- The [legal notice](./NOTICE)

fastcgi-client/Dockerfile

Lines changed: 0 additions & 14 deletions
This file was deleted.

fastcgi-client/README.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

httpd-shibd/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# `aphp/httpd-shibd` container image
22

33
## Description
4-
This image aims to build a custom container made to host an instance of Apache HTTPd and Shibboleth. Since Shibboleth is provided as a HTTPd module that spawns its own process, it cannot be easily isolated in a dedicated container. This container is then spawning and managing both of those processes with a `supervisord` rootless installation.
4+
This image aims to build a custom container made to host an instance of Apache HTTPd and Shibboleth. Since Shibboleth is provided as a HTTPd module that spawns its own process, it cannot be easily isolated in a dedicated container. This container is then spawning and managing both processes with a `supervisord` rootless installation.
55
You can then map a `supervisord` configuration file that will handle the spawning of HTTPd and/or Shibboleth, according to your usecase.
66

77
## Content
8-
This image use [the reccomended way to install Shibboleth](https://shibboleth.atlassian.net/wiki/spaces/SP3/pages/2065335566/RPMInstall) on a RHEL/CentOS/RockyLinux 8+ base OS, alogside httpd.
9-
A dedicated non-root user is then created in order to manage the processes in a secure way.
8+
This image use [the recommended way to install Shibboleth](https://shibboleth.atlassian.net/wiki/spaces/SP3/pages/2065335566/RPMInstall) on a RHEL/CentOS/RockyLinux 8+ base OS, alongside httpd.
9+
A dedicated non-root user is also created in order to manage the processes in a secure way.
1010

1111
## Configuration
1212

1313
### supervisord
1414

15-
Usually, a `supervisord` configuration file is used alongside this image, in order to efficienly manage and logs the processes activity.
15+
Usually, a `supervisord` configuration file is used alongside this image, in order to efficiently manage and logs the processes activity.
1616

1717
Here's an example :
1818

@@ -54,7 +54,7 @@ stdout_logfile_maxbytes=0
5454

5555
### HTTPd
5656

57-
Depending of your usecase, the REDcap Communite Site can provide you with the best ways to configure your HTTPd server.
57+
Depending of your usecase, [the REDcap Community Site](https://projectredcap.org/resources/community/) can provide you with the best ways to configure your HTTPd server.
5858

5959
## How to use
6060

@@ -64,7 +64,7 @@ The container image build from this project's Github Workflow is hosted on the G
6464
docker pull ghcr.io/aphp/redcap-httpd-shibd:latest
6565
```
6666

67-
If you wish to run it alongside the `supervisord` config file, juste use the following command :
67+
If you wish to run it alongside the `supervisord` config file, just use the following command :
6868

6969
```sh
7070
docker run ghcr.io/aphp/redcap-httpd-shibd:latest -v ${your-config-file}:/etc/supervisor/supervisord-redcap-front.conf

php-fpm/Dockerfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ RUN apt-get update -y &&\
66
apt-get purge -y \
77
wget &&\
88
apt-get install -y --no-install-recommends \
9+
default-mysql-client \
910
libfcgi-bin \
1011
msmtp \
1112
libcurl4-openssl-dev \
13+
ghostscript \
1214
libzip-dev \
1315
libfreetype6-dev \
1416
libjpeg62-turbo-dev \

php-fpm/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
# `aphp/php-fpm` container image
22

33
## Description
4-
This image aims to provides with a PHP 8.2 FPM server, including all the dependencies that REDCap needs to operates correctly (this includes several image processing librairies, as well as some custom PHP extensions as `imagick`).
4+
This image aims to provides with a PHP 8.2 FPM server, including all the dependencies that REDCap needs to operates correctly (this includes several image processing libraries, as well as some custom PHP extensions as `imagick`).
55

6-
**This image doesn't contains, nor distributes REDCap binairies**.
6+
**This image doesn't contains, nor distributes REDCap binaries**.
77
If you wish to use REDCap and are not sure where to start, you may visit the dedicated [REDCap Community Site](https://projectredcap.org/resources/community/).
88

99
## Content
10-
The image is based on the official PHP 8.2 FPM image (debian-bookworm flavor), on top of which are added a few librairies and php extensions, such as :
10+
The image is based on the official PHP 8.2 FPM image (debian-bookworm flavor), on top of which are added a few libraries and php extensions, such as :
1111
- `imagick`
1212
- `libpng`
1313
- `libcurl`
1414
- `mysqli`
1515
- `ghostscript`
16+
- `default-mysql-client` (used to setup REDCap DB by the startup probe used by APHP REDCap Helm Chart)
17+
- `libfcgi-bin` (used to launch REDCap cronjobs by the liveness probe probe used by APHP REDCap Helm Chart)
1618

17-
On top of this, the `/app/redcap` (with a symlink pointing to`/var/www/redcap`) and `/edocs` dirs are created with suitable persmissions, ready to handle a REDCap installation.
19+
On top of this, the `/app/redcap` (with a symlink pointing to`/var/www/redcap`) and `/edocs` dirs are created with suitable permissions, ready to handle a REDCap installation.
1820
Finally, the image being rootless, the user `www-data` is exposed as the one executing the process.
1921

2022
## How to use
@@ -25,7 +27,7 @@ The container image build from this project's Github Workflow is hosted on the G
2527
docker pull ghcr.io/aphp/redcap-php-fpm:latest
2628
```
2729

28-
If you want to serve the REDCap application with that image, you will have to retrieve the REDCap install archive, and map the content of the `redcap` directory to `` directory inside the container, like so (example with Docker) :
30+
If you want to serve the REDCap application with that image, you will have to retrieve the REDCap install archive, and map the content of the `redcap` directory to the `/var/www/redcap` directory inside the container, like so (example with Docker) :
2931

3032
```sh
3133
docker run ghcr.io/aphp/redcap-php-fpm:latest -v ${redcap-app-dir}:/var/www/redcap

0 commit comments

Comments
 (0)