Merge pull request #12 from MetroStar/theming

Make Registration Theme Configurable

.github/workflows/publish-docker-image.yaml

@@ -2,12 +2,12 @@ name: Publish Docker Image
 
 on:
   push:
-    branches: ['main']
+    branches: ["main"]
     paths:
-      - docker/**
+      - self-registration/**
   pull_request:
     paths:
-      - docker/**
+      - self-registration/**
 
 env:
   REGISTRY: ghcr.io
@@ -26,7 +26,7 @@ jobs:
       - name: Set the timestamp for version
         run: echo "VERSION=$(date +'%Y%m%d-%H%M')" >> ${GITHUB_ENV}
       - name: Build image
-        run: docker build docker --file docker/Dockerfile --tag $IMAGE_LC --label "runnumber=${GITHUB_RUN_ID}"
+        run: docker build self-registration --file self-registration/Dockerfile --tag $IMAGE_LC --label "runnumber=${GITHUB_RUN_ID}"
       - name: Log in to registry
         run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login $REGISTRY -u $ --password-stdin
       - name: Push image
@@ -40,4 +40,4 @@ jobs:
           echo IMAGE_ID=$IMAGE_ID
           echo VERSION=$VERSION
           docker tag $IMAGE_LC $IMAGE_ID:$VERSION
-          docker push $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

README.md

@@ -3,7 +3,7 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/nebari-plugin-self-registration.svg)](https://pypi.org/project/nebari-plugin-self-registration)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nebari-plugin-self-registration.svg)](https://pypi.org/project/nebari-plugin-self-registration)
 
------
+---
 
 **Table of Contents**
 
@@ -16,7 +16,27 @@
 pip install nebari-plugin-self-registration
 ```
 
+## Running locally with Docker
+
+_Note_: running locally requires a `config.yaml` file to be present within the `self-registration` directory. Please create a copy of the `sample.config.yaml`, rename, and update as needed before proceeding:
+
+1. Navigate to the `self-registration` directory
+2. To build the docker image, run the following:
+
+```
+docker build . --file Dockerfile.local -t self-registration
+```
+
+3. To run the app, run the following:
+
+```
+docker run -p 8000:8000 --name self-registration self-registration
+```
+
+4. Navigate to http://0.0.0.0:8000/registration
+
 ## User Registration via this extension
+
 Steps for self registration:
 
 - Navigate to your Nebari domain.
@@ -34,7 +54,7 @@ Steps for self registration:
 
 - After clicking "Submit" follow the instructions to login with your temporary password. By clicking the "Login" button, it will take you to a Welcome page where you can sign in with Keycloak.
 
-- After you have entered a new password, you will receive a verification email.  
+- After you have entered a new password, you will receive a verification email.
 
 <p align="center">
   <img src="images/account-confirm.png" />

self-registration/Dockerfile.local

@@ -0,0 +1,19 @@
+FROM python:3.12
+
+WORKDIR /app
+
+COPY ./requirements.txt /tmp/requirements.txt
+COPY ./config.yaml .
+
+# need to pre-install cython < 3 to avoid pyyaml >= 5.4.1 incompatibility https://github.com/yaml/pyyaml/issues/601
+RUN echo "cython<3" > /tmp/constraint.txt
+
+RUN PIP_CONSTRAINT=/tmp/constraint.txt pip install --no-cache-dir --upgrade -r /tmp/requirements.txt
+
+COPY ./app /app
+
+# Run web app as non-root
+RUN useradd -m www
+USER www
+
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]