This project utilizes C2PA to embed data, such as a mobile number and name, into images. It includes a comprehensive verification feature that reads manifest data from the image and sends an authentication request to the iVALT app, facilitating secure biometric verification.
- Ensure Docker is installed on your system. If not, download and install Docker from Docker's official site.
Clone the project repository from your version control system:
git clone https://github.com/jaskaran-ivalt/ivalt-c2pa.git
cd ivalt-c2pa
Here's an updated section for the README file, including details about the .env.example
file and the command to copy it:
-
A sample
.env.example
file is provided in the project to help you set up the necessary environment variables. -
To create your
.env
file from the example, run the following command:cp .env.example .env
-
Open the newly created
.env
file and fill in the required values:# Example .env file # iVALT API Configuration IVALT_PRO_API_URL=<your-ivalt-pro-api-url> IVALT_PRO_API_KEY=<your-ivalt-pro-api-key>
- Replace
<your-ivalt-api-key>
and<your-ivalt-pro-api-url>
with actual values needed for your setup.
- Replace
The Dockerfile
is already provided in the project and uses the following content:
FROM jass4704/ivalt-c2pa:latest
If you have made changes to the code or want to build the image locally, you can use the following command:
docker build -t ivalt-c2pa-local .
-t ivalt-c2pa-local
: Tags the image with the nameivalt-c2pa-local
.
Run the container with the appropriate environment variables and port mapping:
docker run -d --env-file .env -p 3000:3000 ivalt-c2pa-local
-d
: Runs the container in detached mode (in the background).--env-file .env
: Loads environment variables from the.env
file.-p 3000:3000
: Maps port 3000 on your local machine to port 3000 on the container.
Once the container is running, access the application in your web browser at:
http://localhost:3000
-
Environment Variables: Ensure that all necessary environment variables are correctly set in the
.env
file. The application depends on these for proper functionality. -
Biometric Verification: This project integrates with the iVALT app for biometric verification. Ensure the iVALT app is configured to handle authentication requests.
-
Viewing Logs: To view logs or debug issues, run:
docker logs <container-id>
-
Stopping the Container: Use the following command to stop the running container:
docker stop <container-id>