Add docker, basic CI, testing/linting tools, and package managers.

.dockerignore

@@ -0,0 +1,12 @@
+.git
+.gitignore
+.env
+nginx
+nginx/*
+xml
+xml/*
+dockerfile
+docker-compose.yml
+README.md
+LICENSE.txt
+public/cache

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Code owners
+/.github/CODEOWNERS @uklibraries/euk
+*       @uklibraries/euk

.github/workflows/ci.yml

@@ -0,0 +1,79 @@
+name: CI
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      COMPOSE_FILE: docker-compose.yml:docker-compose.ci.override.yml
+      COMPOSE_PROJECT_NAME: ci-${{ github.job }}-${{ github.run_id }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build services
+        run: docker compose build
+
+      - name: Show service logs if failed
+        if: failure()
+        run: docker compose logs
+
+      - name: Container runs
+        run: docker compose run --rm --no-deps -T findingaid php -v
+
+      - name: Teardown
+        if: always()
+        run: docker compose down -v --remove-orphans
+
+  lint:
+    needs: build
+    runs-on: ubuntu-latest
+    # TODO: Fix the linting errors
+    # Report the failure, but don't stop the job
+    continue-on-error: true
+    env:
+      COMPOSE_FILE: docker-compose.yml:docker-compose.ci.override.yml
+      COMPOSE_PROJECT_NAME: ci-${{ github.job }}-${{ github.run_id }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build services
+        run: docker compose build
+
+      - name: Show service logs if failed
+        if: failure()
+        run: docker compose logs
+
+      - name: Run linting inside app container
+        run: docker compose run --rm -T findingaid /opt/findingaid/vendor/bin/phpcs -w --exclude=Generic.Files.LineLength --standard=PSR12 /opt/findingaid/tests /opt/findingaid/app
+
+      - name: Teardown
+        if: always()
+        run: docker compose down -v --remove-orphans
+
+  unit-test:
+    needs: build
+    runs-on: ubuntu-latest
+    env:
+      COMPOSE_FILE: docker-compose.yml:docker-compose.ci.override.yml
+      COMPOSE_PROJECT_NAME: ci-${{ github.job }}-${{ github.run_id }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build services
+        run: docker compose build
+
+      - name: Start services
+        run: docker compose up -d findingaid
+
+      - name: Show service logs if failed
+        if: failure()
+        run: docker compose logs
+
+      - name: Run tests inside app container
+        run: docker compose run --rm -T findingaid /opt/findingaid/vendor/bin/phpunit -c /opt/findingaid/phpunit.xml /opt/findingaid/tests
+
+      - name: Teardown
+        if: always()
+        run: docker compose down -v --remove-orphans

.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish release
+on:
+  push:
+    branches: [ main ]
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.sha }}
+
+      - uses: docker/setup-buildx-action@v3
+
+      - name: Login to GitHub Container Registry (ghcr)
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository_owner }}/findingaid:${{ github.sha }}
+          labels: |
+            org.opencontainers.image.revision=${{ github.sha }}

.gitignore

@@ -8,3 +8,4 @@ misc/
 public/minimal*
 public/cache
 is_prod
+.phpunit.result.cache

Dockerfile

@@ -0,0 +1,106 @@
+FROM alpine:3.20 AS jsmin
+
+RUN apk add --no-cache \
+    git \
+    gcc \
+    libc-dev
+
+RUN git clone https://github.com/douglascrockford/JSMin /tmp/jsmin && \
+    gcc /tmp/jsmin/jsmin.c -o /usr/bin/jsmin && \
+    rm -rf /tmp/jsmin
+
+FROM php:8.3-fpm-alpine AS development
+
+# add other deps for dev here
+RUN apk add --no-cache \
+    libzip-dev \
+    bash
+
+COPY --from=composer:2.8 /usr/bin/composer /usr/bin/composer
+COPY --from=jsmin /usr/bin/jsmin /usr/bin/jsmin
+RUN mv "$PHP_INI_DIR/php.ini-development" "$PHP_INI_DIR/php.ini"
+
+WORKDIR /opt/findingaid
+
+COPY ./composer.json .
+COPY ./composer.lock .
+
+RUN composer install --no-interaction
+
+COPY /exe ./exe
+
+COPY entrypoint.sh /usr/local/bin/entrypoint.sh
+RUN chmod +x /usr/local/bin/entrypoint.sh
+
+ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
+EXPOSE 9000
+CMD ["php-fpm", "-F"]
+
+FROM php:8.3-fpm-alpine AS prod-builder
+
+RUN apk add --no-cache bash
+
+COPY --from=composer:2.8 /usr/bin/composer /usr/bin/composer
+COPY --from=jsmin /usr/bin/jsmin /usr/bin/jsmin
+
+WORKDIR /composer
+
+COPY ./composer.json .
+COPY ./composer.lock .
+
+RUN composer install --no-interaction --no-dev
+
+FROM php:8.3-fpm-alpine AS ci
+
+RUN apk add --no-cache \
+    libzip-dev \
+    bash
+
+WORKDIR /app
+
+COPY --from=jsmin /usr/bin/jsmin /usr/bin/jsmin
+COPY --from=development /opt/findingaid/vendor /opt/findingaid/vendor
+COPY ./phpunit.xml /opt/findingaid/phpunit.xml
+COPY /app .
+
+COPY exe/build.sh /opt/findingaid/exe/build.sh
+COPY entrypoint.sh /usr/local/bin/entrypoint.sh
+RUN chmod +x /usr/local/bin/entrypoint.sh
+
+ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
+EXPOSE 9000
+CMD ["php-fpm", "-F"]
+
+FROM php:8.3-fpm-alpine AS production
+
+RUN apk add --no-cache \
+    libzip-dev \
+    bash \
+    jq \
+    curl
+
+COPY --from=jsmin /usr/bin/jsmin /usr/bin/jsmin
+COPY --from=prod-builder /composer/vendor /opt/findingaid/vendor
+RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
+
+WORKDIR /opt/findingaid
+
+COPY ./app ./app
+COPY ./public ./public
+COPY ./exe ./exe
+
+COPY entrypoint.sh /usr/local/bin/entrypoint.sh
+RUN chmod +x /usr/local/bin/entrypoint.sh
+
+RUN ./exe/build.sh
+
+RUN chmod +x /opt/findingaid/exe/findingaid-cache-regen/fa-regen \
+        /opt/findingaid/exe/findingaid-cache-regen/fa-full-regen \
+        /opt/findingaid/exe/findingaid-cache-regen/fetch-ead-arks && \
+    ln -s /opt/findingaid/exe/findingaid-cache-regen/fa-regen /usr/local/bin/fa-regen && \
+    ln -s /opt/findingaid/exe/findingaid-cache-regen/fa-full-regen /usr/local/bin/fa-full-regen && \
+    ln -s /opt/findingaid/exe/findingaid-cache-regen/fetch-ead-arks /usr/local/bin/fetch-ead-arks
+
+ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
+EXPOSE 9000
+CMD ["php-fpm", "-F"]

README.md

@@ -74,6 +74,12 @@ commands might require you to become root.
     ln -s /path/to/findingaid/public ./findingaid
     ```
 
+Installation with Docker
+------------------------
+If your usecase is development, the docker-compose.yml file will start an NGINX container with the appropriate volumes for development.
+
+Once your findingaids are installed, use `docker compose up` to start your development environment.
+
 Copyright
 ---------
 

app/assets/css/extra.css

@@ -1,6 +1,3 @@
-.fa-toc {
-}
-
 .fa-request.fa-requestable-toc {
     display: block;
     margin: 0 auto;
@@ -10,9 +7,6 @@
     float: right;
 }
 
-.fa-request-summary {
-}
-
 .fa-request-summary-note {
     font-style: italic;
 }
@@ -123,10 +117,6 @@ label {
     height: 80vh;
 }
 
-.alert-warning {
-    color: #654f2a;
-}
-
 .alert-harmful {
     background: #b1c9e8;
     color: #282828;
@@ -146,3 +136,50 @@ label {
 .green-alert-text {
     color: #246024;
 }
+
+/* UK LIMESTONE STYLES */
+/* styling to match Limestone's Underline Link */
+a.underline-link {
+    color:#000000;
+    background-attachment: scroll;
+    background-image: linear-gradient(to top,rgba(161,211,237,0.4) 0,rgba(161,211,237,0.4) 0.5em,transparent 0.5em,transparent 110%),linear-gradient(to top,rgba(0,51,160,0.4) 0,rgba(0,51,160,0.4) 2px,transparent 2px,transparent 100%);
+    background-repeat: no-repeat;
+    background-position: 0 0.5em, 0 0;
+    position: relative;
+    transition: 0.2s background-position ease-out;
+    font-weight: 400;
+    z-index: 1;
+    text-decoration: none;
+}
+
+a:hover.underline-link {
+    color:#0033A0;
+    background-position: 0 0, 1000px 2px;
+}
+
+/* styling to match central webcom's in-page alert*/
+.in-page-alert {
+    background-color: #EFF4FD;
+    border-left: 7px solid #1E8AFF;
+    padding: 1rem;
+    align-items: center;
+    color:#000000
+}
+.in-page-alert h2 {
+        text-transform: uppercase;
+        font-size: 1.75rem;
+        font-weight: 900;
+        margin-top: 0;
+        color: #0033A0;
+        line-height: 1.2;
+}
+.in-page-alert h3 {
+        text-transform: uppercase;
+        font-size: 1.5rem;
+        font-weight: 500;
+        margin-bottom: 5px;
+        margin-top: 10px;
+        color: #0033A0;
+        line-height: 1.2;
+
+}

app/config/config.php

@@ -1,25 +1,25 @@
 <?php
 class Config
 {
-    private $config = array();
-    private $repo = array();
+    private $config = [];
+    private $repo = [];
     private $nonuk = null;
 
     public function __construct()
     {
-        $config_file = implode(DIRECTORY_SEPARATOR, array(
+        $config_file = implode(DIRECTORY_SEPARATOR, [
             APP,
             'config',
             'config.json',
-        ));
+        ]);
         if (file_exists($config_file)) {
             $this->config = json_decode(file_get_contents($config_file), true);
         }
-        $repo_file = implode(DIRECTORY_SEPARATOR, array(
+        $repo_file = implode(DIRECTORY_SEPARATOR, [
             APP,
             'config',
             'repo.json',
-        ));
+        ]);
         if (file_exists($repo_file)) {
             $this->repo = json_decode(file_get_contents($repo_file), true);
         }
@@ -48,11 +48,11 @@ public function get_repo($key)
     public function get_nonuk($key)
     {
         if (!isset($this->nonuk)) {
-            $nonuk_config_file = implode(DIRECTORY_SEPARATOR, array(
+            $nonuk_config_file = implode(DIRECTORY_SEPARATOR, [
                 APP,
                 'config',
                 'nonuk-metadata.json',
-            ));
+            ]);
             if (file_exists($nonuk_config_file)) {
                 $this->nonuk = json_decode(file_get_contents($nonuk_config_file), true);
             }