> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/platform/portals-and-apps/beneficiary-portal/deployment-of-strapi.md).

# Deployment of Strapi

This guide explains how to deploy Strapi in any environment to enable integration, testing, and production readiness.

## **Installation of Strapi CMS**

We are implementing **Strapi** as the **CMS for the Beneficiary portal UI** to manage and display dynamic content such as text, news, and announcements.

This guide explains how to deploy Strapi in any environment to enable integration, testing, and production readiness.

***

## **1. Prerequisites**

Before deploying, ensure you have:

* Access to the Kubernetes **cluster** where Strapi will be deployed
* Correct **namespace permissions**
* A **PostgreSQL** instance available
* Docker image of Strapi built and pushed to the container registry

***

## **2. Clone the deployment repository**

All Kubernetes manifests are available in the following GitHub repository:

👉 <https://github.com/shaketshubham/strapideploy>

***

## **3. Deployment files**

The repository contains the following manifests:

1. `postgres-pvc.yaml` — Persistent Volume Claim for PostgreSQL
2. `postgres-service.yaml` — PostgreSQL service definition
3. `postgres-deployment.yaml` — PostgreSQL deployment configuration
4. `pvc.yaml` — Persistent Volume Claim for Strapi uploads
5. `deployment.yaml` — Strapi deployment manifest
6. `service.yaml` — Strapi service configuration
7. `virtualservice.yaml` — Istio VirtualService for external access

***

## **4. Deployment steps**

Run the following commands to deploy Strapi.

#### **Step 1: Set namespace context**

```bash
kubectl config use-context <cluster-name>
kubectl config set-context --current --namespace=<namespace>
```

#### **Step 2: Deploy PostgreSQL**

```bash
kubectl apply -f postgres-pvc.yaml -n <namespace>
kubectl apply -f postgres-service.yaml -n <namespace>
kubectl apply -f postgres-deployment.yaml -n <namespace>
```

#### **Step 3: Deploy Strapi PVC**

```bash
kubectl apply -f pvc.yaml -n <namespace>
```

#### **Step 4: Deploy Strapi application**

```bash
kubectl apply -f deployment.yaml -n <namespace>
kubectl apply -f service.yaml -n <namespace>
```

#### **Step 5: Configure external access**

```bash
kubectl apply -f virtualservice.yaml -n <namespace>
```

***

## **5. Verify the deployment**

1. Check if all pods are running:

```bash
kubectl get pods -n <namespace>
```

2. Check services:

```bash
kubectl get svc -n <namespace>
```

3. Once running, open the Strapi Admin Panel using the configured service or ingress URL.

***

## **6. Environment configuration**

In the **deployment.yaml**, ensure these environment variables are set:

| Variable            | Description                                      |
| ------------------- | ------------------------------------------------ |
| `DATABASE_HOST`     | PostgreSQL service name                          |
| `DATABASE_PORT`     | Database port (default: 5432)                    |
| `DATABASE_NAME`     | Strapi database name                             |
| `DATABASE_USERNAME` | PostgreSQL username                              |
| `DATABASE_PASSWORD` | PostgreSQL password                              |
| `APP_KEYS`          | Application keys (comma-separated)               |
| `JWT_SECRET`        | Secret key for authentication                    |
| `NODE_ENV`          | Set to `production` or `development` as required |

> 💡 Configure these values either via **Kubernetes Secrets** or **Rancher environment variables**.

***

## **7. CORS and API access**

Update the `config/middlewares.js` file or use environment variables to allow frontend domains.

Example:

```js
module.exports = [
  'strapi::logger',
  'strapi::errors',
  {
    name: 'strapi::security',
    config: {
      contentSecurityPolicy: {
        useDefaults: true,
        directives: {
          'connect-src': ["'self'", 'https:', 'http:', 'https://portal.openg2p.org'],
        },
      },
    },
  },
  'strapi::cors',
];
```

***

## **8. Testing API connection**

Once deployed, you can test API connectivity using curl or a browser:

```bash
curl https://<your-strapi-domain>/api/news
```

If you receive a JSON response, Strapi is successfully serving data.

***

## **9. Repository reference**

All manifests are available in the GitHub repository:\
👉 <https://github.com/shaketshubham/strapideploy>

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openg2p.org/platform/portals-and-apps/beneficiary-portal/deployment-of-strapi.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.