> For the complete documentation index, see [llms.txt](https://docs.perigee.software/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perigee.software/transforms/automation/configuration.md).

# Configuration

## Keys

A "Key" concept of the automation utility is that we don't store sensitive information (like connection strings, SFTP information, etc) inside the package. Instead, we reference the keys they belong to.

Let's say we're transforming data from <mark style="color:orange;">**Pizzeria**</mark>'s SFTP server to a local <mark style="color:orange;">**Reporting**</mark> folder. We would configure our source to be an SFTP server with the <mark style="color:orange;">**Pizzeria**</mark> key, and the target to be a folder with the <mark style="color:orange;">**Reporting**</mark> key.&#x20;

<figure><img src="https://2203366127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FloJjRj49SSQfSrp7vuw9%2Fuploads%2FBI2s7sd7Ufpuq47oHMjy%2Fimage.png?alt=media&amp;token=bc2ff959-6d47-432a-bc6a-2b0b5612fca2" alt=""><figcaption><p>Keys</p></figcaption></figure>

To actually provide the secure SFTP credentials, and the folder path, you would do so locally alongside your client application.&#x20;

<figure><img src="https://2203366127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FloJjRj49SSQfSrp7vuw9%2Fuploads%2FLqbu8fXYHWGcdtwNqEkX%2Fimage.png?alt=media&amp;token=f7f6e1aa-411c-445d-98d1-7efe8e562d18" alt=""><figcaption><p>Client config</p></figcaption></figure>

## Encryption / Decryption

The application supports both encryption and decryption of the settings.json file associated with the application.&#x20;

### Encrypt

To encrypt, run the application with the **`-e`** flag followed by the password. An example:

```
TransformClient.exe -e "Expelliarmus"
```

The application credentials will now be encrypted and not visible under inspection.&#x20;

{% hint style="success" %}
The application will create a **.bak.json** file of the credentials before attempting to encrypt. This is to prevent data loss or accidents. <mark style="color:red;">**If you're satisfied with the encrypted results, don't forget to delete this file**</mark>.&#x20;
{% endhint %}

<figure><img src="https://2203366127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FloJjRj49SSQfSrp7vuw9%2Fuploads%2FNkrGSQbykZm6ocDQydW9%2Fimage.png?alt=media&amp;token=52b82a90-48c6-43cc-81aa-9992b45b7d88" alt=""><figcaption></figcaption></figure>

### Decrypt

To decrypt, send the **`-d`** flag. An example:

```
TransformClient.exe -d "Expelliarmus"
```

And just like that, if the passwords matched, you'll get a decrypted result.&#x20;


---

# 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.perigee.software/transforms/automation/configuration.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.
