awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: adds laravel forge secret sync docs

Browse Source
This commit is contained in:
Piyush Gupta
2025-10-13 23:47:42 +05:30
parent cbf893bf32
commit 573d6ec9a4
13 changed files with 175 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

163
docs/integrations/secret-syncs/laravel-forge.mdx Normal file
View File

@@ -0,0 +1,163 @@
---
title: "Laravel Forge Sync"
description: "Learn how to configure a Laravel Forge Sync for Infisical."
---
**Prerequisites:**
- Create a [Laravel Forge Connection](/integrations/app-connections/laravel-forge)
<Tabs>
<Tab title="Infisical UI">
<Steps>
<Step title="Add Sync">
Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Click on the **Add Sync** button.
![Secret Syncs Tab](/images/secret-syncs/general/secret-sync-tab.png)
</Step>
<Step title="Select 'Laravel Forge'">
![Select Laravel Forge](/images/secret-syncs/laravel-forge/select-option.png)
</Step>
<Step title="Configure source">
Configure the **Source** from where secrets should be retrieved, then click **Next**.
![Configure Source](/images/secret-syncs/laravel-forge/sync-source.png)
- **Environment**: The project environment to retrieve secrets from.
- **Secret Path**: The folder path to retrieve secrets from.
<Tip>
If you need to sync secrets from multiple folder locations, check out [secret imports](/documentation/platform/secret-reference#secret-imports).
</Tip>
</Step>
<Step title="Configure destination">
Configure the **Destination** to where secrets should be deployed, then click **Next**.
![Configure Destination](/images/secret-syncs/laravel-forge/sync-destination.png)
- **Laravel Forge Connection**: The Laravel Forge Connection to authenticate with.
- **Organization**: The Organization in which the server and site reside.
- **Server**: The Server on which the site resides.
- **Site**: The Site for which secrets should be synced.
</Step>
<Step title="Configure Sync Options">
Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
![Configure Options](/images/secret-syncs/laravel-forge/sync-options.png)
- **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync.
- **Overwrite Destination Secrets**: Removes any secrets at the destination endpoint not present in Infisical.
- **Import Secrets (Prioritize Infisical)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Infisical over Laravel Forge when keys conflict.
- **Import Secrets (Prioritize Laravel Forge)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Laravel Forge over Infisical when keys conflict.
- **Key Schema**: Template that determines how secret names are transformed when syncing, using `{{secretKey}}` as a placeholder for the original secret name and `{{environment}}` for the environment.
<Note>
We highly recommend using a Key Schema to ensure that Infisical only manages the specific keys you intend, keeping everything else untouched.
</Note>
- **Auto-Sync Enabled**: If enabled, secrets will automatically be synced from the source location when changes occur. Disable to enforce manual syncing only.
- **Disable Secret Deletion**: If enabled, Infisical will not remove secrets from the sync destination. Enable this option if you intend to manage some secrets manually outside of Infisical.
</Step>
<Step title="Configure details">
Configure the **Details** of your Laravel Forge Sync, then click **Next**.
![Configure Details](/images/secret-syncs/laravel-forge/sync-details.png)
- **Name**: The name of your sync. Must be slug-friendly.
- **Description**: An optional description for your sync.
</Step>
<Step title="Review configuration">
Review your Laravel Forge Sync configuration, then click **Create Sync**.
![Review Configuration](/images/secret-syncs/laravel-forge/sync-review.png)
</Step>
<Step title="Sync created">
If enabled, your Laravel Forge Sync will begin syncing your secrets to the destination endpoint.
![Sync Created](/images/secret-syncs/laravel-forge/sync-created.png)
</Step>
</Steps>
</Tab>
<Tab title="API">
To create a **Laravel Forge Sync**, make an API request to the [Create Laravel Forge Sync](/api-reference/endpoints/secret-syncs/laravel-forge/create) API endpoint.
### Sample request
```bash Request
curl --request POST \
--url https://app.infisical.com/api/v1/secret-syncs/laravel-forge \
--header 'Content-Type: application/json' \
--data '{
"name": "my-laravel-forge-sync",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "sync to laravel forge site",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "dev",
"secretPath": "/",
"isEnabled": true,
"isAutoSyncEnabled": true,
"syncOptions": {
"initialSyncBehavior": "overwrite-destination",
"disableSecretDeletion": false
},
"destinationConfig": {
"orgSlug": "org-abc123",
"orgName": "org-name",
"serverId": "server-abc123",
"serverName": "server-name",
"siteId": "site-abc123",
"siteName": "site-name"
}
}'
```
### Sample response
```bash Response
{
"secretSync": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "my-laravel-forge-sync",
"description": "sync to laravel forge site",
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2025-07-19T12:00:00Z",
"updatedAt": "2025-07-19T12:00:00Z",
"syncStatus": "succeeded",
"lastSyncJobId": "job-1234",
"lastSyncMessage": null,
"lastSyncedAt": "2025-07-19T12:00:00Z",
"syncOptions": {
"initialSyncBehavior": "overwrite-destination",
"disableSecretDeletion": false
},
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connection": {
"app": "laravel-forge",
"name": "my-laravel-forge-connection",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"environment": {
"slug": "dev",
"name": "Development",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"folder": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "/"
},
"destination": "laravel-forge",
"destinationConfig": {
"orgSlug": "org-abc123",
"orgName": "org-name",
"serverId": "server-abc123",
"serverName": "server-name",
"siteId": "site-abc123",
"siteName": "site-name"
}
}
}
```
</Tab>
</Tabs>

2
docs/integrations/secret-syncs/netlify.mdx
View File

@@ -78,6 +78,7 @@ description: "Learn how to configure a Netlify Sync for Infisical."
![Sync Created](/images/secret-syncs/netlify/sync-created.png)
</Step>
</Steps>
</Tab>
<Tab title="API">
@@ -157,5 +158,6 @@ description: "Learn how to configure a Netlify Sync for Infisical."
}
}
```
</Tab>
</Tabs>