> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Apinizer

> You can install Apinizer on Kubernetes environment using Helm. By adding Helm chart repository, you can easily manage and configure Apinizer components.

<Info>
  Apinizer requires MongoDB during installation. If MongoDB is not installed, it needs to be installed first.
</Info>

## Prerequisites

Before starting the installation, make sure the following requirements are met:

* Kubernetes cluster is ready and accessible
* Helm is installed in your environment
* MongoDB application is installed

<Note>
  If Helm is not installed, you can review the [Helm Installation Document](/en/setup/helm/apinizer) page.
</Note>

## 1) Adding Repository

Add apinizer chart repo to Helm.

```bash theme={null}
helm repo add apinizer-charts https://apinizer1.github.io/apinizer-charts
helm repo update
```

## 2) Apinizer Installation

You can perform Apinizer installation without any special settings by running the following command:

```bash theme={null}
helm install apinizer-charts apinizer-charts/apinizer
```

<Info>
  **Note:** Apinizer version `2025.07.0` is used in the current installation. You can review all Apinizer versions on [Docker Hub](https://hub.docker.com/u/apinizercloud).
</Info>

## Optional Parameters

| Option                 | Default Value                                                                                                                                                   | Description                                                                                                                                                                                                                   |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `image.manager`        | `apinizercloud/manager:2025.07.0`                                                                                                                               | Specifies the version of Apinizer manager image.                                                                                                                                                                              |
| `image.worker`         | `apinizercloud/worker:2025.07.0`                                                                                                                                | Specifies the version of Apinizer worker image.                                                                                                                                                                               |
| `image.cache`          | `apinizercloud/cache:2025.07.0`                                                                                                                                 | Specifies the version of Apinizer cache image.                                                                                                                                                                                |
| `mongoDB.hostNames[0]` | `mongo-db-0.mongo-service.mongo.svc.cluster.local`                                                                                                              | If you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.                                   |
| `mongoDB.username`     | If MongoDB installation was done with Helm: `kubectl get secret -n mongo mongodb-secret -o jsonpath="{.data.MONGO_ROOT_USERNAME}" &#124; base64 --decode; echo` | If you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.                                   |
| `mongoDB.password`     | If MongoDB installation was done with Helm: `kubectl get secret -n mongo mongodb-secret -o jsonpath="{.data.MONGO_ROOT_PASSWORD}" &#124; base64 --decode; echo` | If you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.                                   |
| `mongoDB.dbName`       | `apinizerdb`                                                                                                                                                    | If you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.                                   |
| `mongoDB.authSource`   | `admin`                                                                                                                                                         | If you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.                                   |
| `mongoDB.port`         | `25080`                                                                                                                                                         | If you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.                                   |
| `environment.deploy`   | `true`                                                                                                                                                          | This value enables creating and deploying an environment in Apinizer. If you do not want environment creation, you can set this value to `false`.                                                                             |
| `ns.namespace`         | `prod`                                                                                                                                                          | Apinizer runs under the specified namespace when adding environment.                                                                                                                                                          |
| `access.url`           | `apigateway.apinizer.com`                                                                                                                                       | By default, this value is added to the Access URL field of environments. You can specify your own DNS address or IP address during Helm installation; you can also easily update it through the interface after installation. |

When installing Apinizer components, MongoDB connection information and environment deploy status can be specified with example usage of the following optional parameters:

```bash theme={null}
helm install apinizer-charts apinizer-charts/apinizer \
  --set mongoDB.hostNames[0]=<mongo-hostname0> \
  --set mongoDB.hostNames[1]=<mongo-hostname1> \
  --set mongoDB.hostNames[2]=<mongo-hostname2> \
  --set mongoDB.username=<username> \
  --set mongoDB.password=<password> \
  --set mongoDB.port=<port> \
  --set environment.deploy=<true|false>
```