Other misc changes

Author: BryceStevenWilley

.github/workflows/build_and_test.yml

@@ -8,7 +8,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 11
+      - name: Set up JDK 21
         uses: actions/setup-java@v4
         with:
           java-version: '21'

.github/workflows/docs_site.yml

@@ -0,0 +1,62 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: 'pip'
+      - name: Build Mkdocs
+        run: |
+            pip install mkdocs mkdocs-awesome-nav
+            mkdocs build
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'adopt'
+          cache: 'maven'
+      - name: Build Javadoc and Enunciate Swagger UI
+        run: |
+            mvn --batch-mode -Preproducible compile javadoc:javadoc javadoc:aggregate
+            cp -r target/reports/apidocs site/apidocs
+            cp -r proxyserver/target/enunciate-docs/apidocs site/endpoints
+            # Add a setting to swagger-ui to turn off the "Try it now" buttons
+            sed -i 's/url\: url/url\: url\, supportedSubmitMethods\: \[\]/' site/endpoints/ui/swagger-initializer.js
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:

docs/.nav.yml

@@ -3,4 +3,6 @@ nav:
   - developing.md
   - operations_guide/index.md
   - architecture.md
+  - "REST API Docs 🔗": /endpoints
+  - "Javadocs 🔗": /apidocs
   - "*"

docs/https.md

@@ -19,12 +19,12 @@ We are still working to improve the steps, but current the process is:
    Something like `openssl rand -base64 12` will generate 16 characters securely.
    * You can also set a `MONITORING_EMAIL` which will be used for email renewal reminders from Lets Encrypt.
 2. Start up the docker containers (see [setup.md](setup.md)).
-3. Start a bash shell inside the running container: `docker exec -it efileproxyserver-efspjava-1 /bin/sh`
+3. Start a shell inside the running container: `docker exec -it efileproxyserver-efspjava-1 /bin/sh`
 4. Change directories to the app: `cd /app`.
 5. Run the ACME renewal process: `java -cp efspserver-with-deps.jar edu.suffolk.litlab.efspserver.services.acme.AcmeRenewal renew`.
    If the renewal process succeeded, `acme-domain-chain.crt` and `tls_server_cert.jks`
    should both be present in `/tmp/tls_certs` inside the container and in `src/main/config` outside the container.
-6. Exit the bash shell you started, and rebuild and restart the java docker container.
+6. Exit the shell you started, and rebuild and restart the java docker container.
 
 The newly started container should be able to serve HTTPS correctly!