Obtain SerenityGPT Container Images

This guide describes how to obtain and work with SerenityGPT container images. Follow these steps to get the container images and prepare them for deployment.

Prerequisites

Before you begin, make sure you have:

Docker installed and running on your system.
Access credentials for the SerenityGPT container registry.
A database provisioned and configured (see Provisioning a Database).

Obtain Container Images

You can obtain the SerenityGPT container images in two ways:

Pull from the SerenityGPT Container Registry.
Import from a provided archive.

Option 1: Pull from SerenityGPT Container Registry

1. Log in to the SerenityGPT container registry

Use one of these methods:

Azure CLI:

az login
az acr login --name serenitygpt.azurecr.io

Docker CLI:

docker login serenitygpt.azurecr.io -u <user-id> -p <password>

For the Docker CLI method, get an access token through the Azure Portal or use this Azure CLI command:

az acr login --name serenitygpt.azurecr.io --expose-token

2. Pull the SerenityGPT image

docker pull serenitygpt.azurecr.io/serenity-web:latest

Option 2: Import from Provided Archive

If you have a .tar.gz archive of the SerenityGPT image:

1. Import the image into your local Docker

docker load < serenity-web-latest.tar.gz

Verify the Image

After you get the image, check that it's in your local Docker:

docker images | grep serenity-web

You should see output like this:

serenitygpt.azurecr.io/serenity-web   latest    <image-id>    <size>

Test that the container starts (optional)

This step will appear to fail

This step will appear to fail because the application settings aren't fully configured yet. This configuration step is covered in the next section of this documentation. The purpose of the following (optional) commands is to validate that the image imported correctly and is runnable. If you see a log output indicating an error due to missing configuration, it indicates that the image imported correctly.

To test the SerenityGPT container locally, run the following command:

docker run -d --name serenity-web \
  -p 8080:8080 \
  serenitygpt.azurecr.io/serenity-web:latest

You should see output similar to the following:

 Traceback (most recent call last):                                                            
 <...some lines removed...>
     settings = Settings()                                                                     
   File "pydantic/main.py", line XXX, in pydantic.main.BaseModel.__init__                      
 pydantic.error_wrappers.ValidationError: 3 validation errors for Settings                     
 database -> name                                                                              
   field required (type=value_error.missing)                                                   
 database -> user                                                                              
   field required (type=value_error.missing)                                                   
 database -> password                                                                          
   field required (type=value_error.missing)

If you see an error similar to the following, it means the image has been imported correctly, and the container is ready to be configured.

If you are unable to import and start the container image, contact support@serenity.com for help.

Next steps

Now that you have the SerenityGPT container image and it's running, you can set up and configure your SerenityGPT instance. See the next sections of the documentation for more instructions on customization and usage.