Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,21 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket and the function that the template creates take the same name. If the name is already in use, the platform returns an error message.

</DocStep>
<DocStep title="Start the deployment" />
<DocStep title="Start the deployment">

Select **Deploy**.

</DocStep>
</DocSteps>

A window shows the deployment logs while it runs. When the deployment completes, the page shows the application's details, a browser link to it, and options to continue. The deployment leaves you with:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket and the function that the template creates take the same name. If the name is already in use, the platform returns an error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

In **Application Name**, enter a unique name for the application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import DocCard from '@aziontech/webkit/doc-card'

You can deploy a website for your services and portfolio to Azion from the CosmicJS Agency Website template in Azion Console. To create an application without a template, refer to [Applications quickstart](/en/documentation/platform/applications/quickstart/).

The template creates a dynamic, customizable website that shows your services and portfolio. The website is built with Cosmic's **React components** and **Blocks**. The template uses Next.js `14.2.5`.
The template creates a dynamic, customizable website that shows your services and portfolio. The website is built with Cosmic's React components and Blocks. The template uses Next.js `14.2.5`.

The deployment creates a GitHub repository for your project, an [application](/en/documentation/platform/applications/) that serves it, and a domain to reach it. The application uses [Application Accelerator](/en/documentation/platform/applications/application-accelerator/), [Functions](/en/documentation/platform/functions/), and [Cache](/en/documentation/platform/applications/cache/), and their usage can generate costs. For more information, refer to [Pricing](/en/documentation/fundamentals/pricing/).

Expand Down Expand Up @@ -47,7 +47,11 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

In **Application Name**, enter a unique name for the application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

In **Application Name**, enter a unique name for the application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

In **Application Name**, enter a unique name for the application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket and the function that the template creates take the same name. If the name is already in use, the platform returns an error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,21 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket that the template creates takes the same name. If the name is already in use, the platform returns an error message.

</DocStep>
<DocStep title="Start the deployment" />
<DocStep title="Start the deployment">

Select **Deploy**.

</DocStep>
</DocSteps>

A window shows the deployment logs while it runs. When the deployment completes, the page shows the application's details, a browser link to it, and options to continue.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,21 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket that the template creates takes the same name. If the name is already in use, the platform returns an error message.

</DocStep>
<DocStep title="Start the deployment" />
<DocStep title="Start the deployment">

Select **Deploy**.

</DocStep>
</DocSteps>

A window shows the deployment logs while it runs. When the deployment completes, the page shows the application's details, a browser link to it, and options to continue.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The template holds standard cache policies and settings for static content, dyna

The deployment creates an [application](/en/documentation/platform/applications/) that carries every cache rule and setting of the template. The application uses [Application Accelerator](/en/documentation/platform/applications/application-accelerator/) and [Image Processor](/en/documentation/platform/applications/image-processor/), and their usage can generate costs. For more information, refer to [Pricing](/en/documentation/fundamentals/pricing/).

After the deployment, link your origin to the application to apply these rules to your content and deliver it through Azion. For more information, refer to [Connectors](/en/documentation/platform/connectors/).
After the deployment, you can serve the application from a domain you own. For more information, refer to [Add a custom domain](#add-a-custom-domain).

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,12 @@ To update the function:
</DocStep>
<DocStep title="Open the tab that holds the setting">

Open the **Main Settings**, **Code**, or **Arguments** tab, and change the setting.
Open the **Main Settings**, **Code**, or **Arguments** tab.

</DocStep>
<DocStep title="Change the setting">

In that tab, change the setting.

</DocStep>
<DocStep title="Select Save">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket and the function that the template creates take the same name. If the name is already in use, the platform returns an error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,21 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket and the function that the template creates take the same name. If the name is already in use, the platform returns an error message.

</DocStep>
<DocStep title="Start the deployment" />
<DocStep title="Start the deployment">

Select **Deploy**.

</DocStep>
</DocSteps>

A window shows the deployment logs while it runs. When the deployment completes, the page shows the application's details, a browser link to it, and options to continue.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,11 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket and the function that the template creates take the same name. If the name is already in use, the platform returns an error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,21 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket that the template creates takes the same name. If the name is already in use, the platform returns an error message.

</DocStep>
<DocStep title="Start the deployment" />
<DocStep title="Start the deployment">

Select **Deploy**.

</DocStep>
</DocSteps>

A window shows the deployment logs while it runs. When the deployment completes, the page shows the application's details, a browser link to it, and options to continue.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,21 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the application">

Enter a unique name that you can remember. The storage bucket that the template creates takes the same name. If the name is already in use, the platform returns an error message.

</DocStep>
<DocStep title="Start the deployment" />
<DocStep title="Start the deployment">

Select **Deploy**.

</DocStep>
</DocSteps>

A window shows the deployment logs while it runs. When the deployment completes, the page shows the application's details, a browser link to it, and options to continue.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,14 @@ To deploy the template:
A window opens to confirm the installation of the [Azion GitHub App](/en/documentation/guides/application-development/automation/azion-github-app/), which connects your GitHub account with Azion. In that window, define the app's permissions and repository access.

</DocStep>
<DocStep title="Select the Git scope to work with" />
<DocStep title="Select the Git Scope">

Select the **Git Scope** to work with.

</DocStep>
<DocStep title="Name the agent">

Enter a unique name that you can remember. By default, the database name follows the pattern `<agent_name>-database`. If the name is already in use, the platform returns an error message.
Enter a unique name that you can remember. By default, the database name follows the pattern `<your-agent-name>-database`. If the name is already in use, the platform returns an error message.

</DocStep>
<DocStep title="Enter your OpenAI API key" />
Expand Down Expand Up @@ -85,16 +89,16 @@ To set up the database and upload your documents:
2. Check that the project has a `.env` file with your environment variables. To create a new one, use this structure:

```bash
AZION_TOKEN="azion_token"
OPENAI_API_KEY="your_openai_key"
AZION_TOKEN="[TOKEN VALUE]"
OPENAI_API_KEY="[TOKEN VALUE]"
OPENAI_MODEL= 'gpt-4o'
EMBEDDING_MODEL= 'text-embedding-3-small'

# EdgeSQL database and table names. Usually, table names are not changed,
# and the database name is the name of your agent + database: agent_name_database
MESSAGE_STORE_DB_NAME="yourdb-database"
# Database and table names in SQL Database. The table names usually stay the same,
# and the database name is the name of your agent followed by -database.
MESSAGE_STORE_DB_NAME="<your-agent-name>-database"
MESSAGE_STORE_TABLE_NAME='messages'
VECTOR_STORE_DB_NAME="yourdb-database"
VECTOR_STORE_DB_NAME="<your-agent-name>-database"
VECTOR_STORE_TABLE_NAME='vectors'

# Optional: Langsmith to trace the requests and responses
Expand All @@ -117,8 +121,9 @@ To set up the database and upload your documents:

The setup configures the vector database and creates its `vectors` table. The `migrations/uploadDocs.ts` file only inserts documents into existing databases, so run this setup before the first upload.

4. Place your document files in the `migrations/files/` folder. If the `files` folder does not exist, create it. The supported formats are PDF, Markdown (`.md`), Text (`.txt`), and JSON.
5. Upload the documents:
4. If the project has no `migrations/files/` folder, create it.
5. Place your document files in `migrations/files/`. The supported formats are PDF, Markdown (`.md`), Text (`.txt`), and JSON.
6. Upload the documents:

```bash
yarn upload-docs
Expand All @@ -131,14 +136,14 @@ The database holds your reference documents, and the application can access them
The template also creates a table that stores the messages exchanged with the agent. By default, the table keeps messages for 14 days.

:::tip
To view your databases and tables and run SQL commands from a terminal, use the [EdgeSQL Shell](/en/documentation/platform/sql-database/edgesql-shell/), a command-line tool for SQL Database. You can also work with the databases through the [Azion API v4](/en/documentation/platform/sql-database/databases-and-queries/#list-databases).
To view your databases and tables and run SQL commands from a terminal, use the [EdgeSQL Shell](/en/documentation/platform/sql-database/edgesql-shell/), a command-line tool for SQL Database. You can also work with the databases through the Azion API v4. For the API operations, refer to [Databases and queries](/en/documentation/platform/sql-database/databases-and-queries/#list-databases).
:::

---

## Backend environment variables

The backend application of the LangGraph AI Agent Boilerplate reads its configuration from the `.env` file of the project. Not every variable is required.
The `.env` file of the backend project holds its environment variables. Not every variable is required.

| Environment variable | Description | Required |
| --- | --- | --- |
Expand All @@ -149,10 +154,12 @@ The backend application of the LangGraph AI Agent Boilerplate reads its configur
| `LANGSMITH_API_KEY` | The API key for accessing Langsmith services. | No |
| `LANGCHAIN_PROJECT` | The Langchain project identifier. | No |
| `LANGCHAIN_TRACING_V2` | Turns Langchain tracing on or off. Set it to `true` or `false`. | No |
| `MESSAGE_STORE_DB_NAME` | The name of the database that stores the conversation history messages. By default, it is the same database that stores the documents. Default name: `<agent-name>-database`. | Yes |
| `MESSAGE_STORE_DB_NAME` | The name of the database that stores the conversation history messages. By default, it is the same database that stores the documents. Default name: `<your-agent-name>-database`. | Yes |
| `MESSAGE_STORE_TABLE_NAME` | The name of the table, in the messages database, that stores the conversation history. Default name: `messages`. | Yes |
| `VECTOR_STORE_DB_NAME` | The name of the database that stores your documents as vector embeddings. By default, it is the same database that stores the messages. Default name: `<agent-name>-database`. | Yes |
| `VECTOR_STORE_DB_NAME` | The name of the database that stores your documents as vector embeddings. By default, it is the same database that stores the messages. Default name: `<your-agent-name>-database`. | Yes |
| `VECTOR_STORE_TABLE_NAME` | The name of the table, in the documents database, that stores the embeddings. Default name: `vectors`. | Yes |
| `CLERK_PUBLISHABLE_KEY` | The public key of Clerk, for Clerk authentication with your frontend. | No |
| `CLERK_SECRET_KEY` | The private key of Clerk, for Clerk authentication with your frontend. | No |

---

Expand Down
Loading
Loading