You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,12 +12,12 @@ Those images are as follow :
12
12
13
13
Each subfolder contains its own README file.
14
14
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**.
16
16
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/).
17
17
18
-
## Continous Integration / Continous Delivery
18
+
## continuous Integration / continuous Delivery
19
19
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 :
21
21
- Lint the Dockerfile using `Hadolint`
22
22
- Scan the container images using `Dockle`
23
23
- 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).
29
29
30
30
## How is this project licensed?
31
31
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 :
Copy file name to clipboardExpand all lines: httpd-shibd/README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
# `aphp/httpd-shibd` container image
2
2
3
3
## 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.
5
5
You can then map a `supervisord` configuration file that will handle the spawning of HTTPd and/or Shibboleth, according to your usecase.
6
6
7
7
## 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.
10
10
11
11
## Configuration
12
12
13
13
### supervisord
14
14
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.
16
16
17
17
Here's an example :
18
18
@@ -54,7 +54,7 @@ stdout_logfile_maxbytes=0
54
54
55
55
### HTTPd
56
56
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.
58
58
59
59
## How to use
60
60
@@ -64,7 +64,7 @@ The container image build from this project's Github Workflow is hosted on the G
Copy file name to clipboardExpand all lines: php-fpm/README.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,22 @@
1
1
# `aphp/php-fpm` container image
2
2
3
3
## 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`).
5
5
6
-
**This image doesn't contains, nor distributes REDCap binairies**.
6
+
**This image doesn't contains, nor distributes REDCap binaries**.
7
7
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/).
8
8
9
9
## 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 :
11
11
-`imagick`
12
12
-`libpng`
13
13
-`libcurl`
14
14
-`mysqli`
15
15
-`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)
16
18
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.
18
20
Finally, the image being rootless, the user `www-data` is exposed as the one executing the process.
19
21
20
22
## How to use
@@ -25,7 +27,7 @@ The container image build from this project's Github Workflow is hosted on the G
25
27
docker pull ghcr.io/aphp/redcap-php-fpm:latest
26
28
```
27
29
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) :
29
31
30
32
```sh
31
33
docker run ghcr.io/aphp/redcap-php-fpm:latest -v ${redcap-app-dir}:/var/www/redcap
0 commit comments