mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
ENG-2595 (#3976)
* feat: implement railway secret sync * fix: railway sync config * feat: add documentation on railway * fix: undo mock on-prem change * lint: fix * fix: cleanup railway integration * fix: retry and doc images * fix: sync fields * fix: query typo * Update docs/docs.json Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
This commit is contained in:
Sid
164
docs/integrations/app-connections/railway.mdx
Normal file
164
docs/integrations/app-connections/railway.mdx
Normal file
@@ -0,0 +1,164 @@
|
||||
---
|
||||
title: "Railway Connection"
|
||||
description: "Learn how to configure a Railway Connection for Infisical."
|
||||
---
|
||||
|
||||
Infisical supports the use of [API Tokens](https://docs.railway.com/guides/public-api#creating-a-token) to connect with Railway.
|
||||
|
||||
## Create a Railway API Token
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Team Token">
|
||||
A team token provides access to all resources within a team. It cannot be used to access personal resources in Railway.
|
||||
|
||||
<Steps>
|
||||
<Step title="Click the profile image in the top-right corner and select 'Account Settings'">
|
||||
|
||||
</Step>
|
||||
<Step title="In the personal settings sidebar, click on 'Tokens'">
|
||||
|
||||
</Step>
|
||||
<Step title="Enter a token name and select a team">
|
||||
Make sure to provide a descriptive name and select the correct team.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Click on 'Create'">
|
||||
|
||||
</Step>
|
||||
<Step title="Save the token">
|
||||
After clicking 'Create', your access token will be displayed. Save it securely for later use.
|
||||
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
|
||||
<Tab title="Account Token">
|
||||
If no team is selected, the token will be associated with your personal Railway account and will have access to all your individual and team resources.
|
||||
|
||||
<Steps>
|
||||
<Step title="Click the profile image in the top-right corner and select 'Account Settings'">
|
||||
|
||||
</Step>
|
||||
<Step title="In the personal settings sidebar, click on 'Tokens'">
|
||||
|
||||
</Step>
|
||||
<Step title="Enter a token name and select 'No workspace'">
|
||||
Provide a descriptive name and ensure no team is selected. This will create an account-level token.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Click on 'Create'">
|
||||
|
||||
</Step>
|
||||
<Step title="Save the token">
|
||||
After clicking 'Create', your access token will be shown. Save it for future use.
|
||||
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
|
||||
<Tab title="Project Token">
|
||||
Project tokens are limited to a specific environment within a project and can only be used to authenticate requests to that environment.
|
||||
|
||||
<Steps>
|
||||
<Step title="Open your Railway dashboard and click on a project">
|
||||
|
||||
</Step>
|
||||
<Step title="On the project page, click 'Settings' in the top-right corner">
|
||||
|
||||
</Step>
|
||||
<Step title="In the left sidebar, scroll to the bottom and click on 'Tokens'">
|
||||
|
||||
</Step>
|
||||
<Step title="Enter a token name and select an environment">
|
||||
Provide a descriptive name and select the appropriate environment for the token.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Click on 'Create'">
|
||||
|
||||
</Step>
|
||||
<Step title="Save the token">
|
||||
After clicking 'Create', the access token will be displayed. Be sure to save it for later use.
|
||||
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Create a Railway Connection in Infisical
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Infisical UI">
|
||||
<Steps>
|
||||
<Step title="Navigate to App Connections">
|
||||
In your Infisical dashboard, go to **Organization Settings** and open the [**App Connections**](https://app.infisical.com/organization/app-connections) tab.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Select Railway Connection">
|
||||
Click **+ Add Connection** and choose **Railway Connection** from the list of integrations.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Fill out the Railway Connection form">
|
||||
Complete the form by providing:
|
||||
- A descriptive name for the connection
|
||||
- An optional description
|
||||
- The type of token you created earlier
|
||||
- The token value from the previous step
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Connection created">
|
||||
After submitting the form, your **Railway Connection** will be successfully created and ready to use with your Infisical projects.
|
||||
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
|
||||
<Tab title="API">
|
||||
To create a Railway Connection via API, send a request to the [Create Railway Connection](/api-reference/endpoints/app-connections/railway/create) endpoint.
|
||||
|
||||
### Sample request
|
||||
|
||||
```bash Request
|
||||
curl --request POST \
|
||||
--url https://app.infisical.com/api/v1/app-connections/railway \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
"name": "my-railway-connection",
|
||||
"method": "team-token",
|
||||
"credentials": {
|
||||
"apiToken": "[TEAM TOKEN]"
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
### Sample response
|
||||
|
||||
```bash Response
|
||||
{
|
||||
"appConnection": {
|
||||
"id": "e5d18aca-86f7-4026-a95e-efb8aeb0d8e6",
|
||||
"name": "my-railway-connection",
|
||||
"description": null,
|
||||
"version": 1,
|
||||
"orgId": "6f03caa1-a5de-43ce-b127-95a145d3464c",
|
||||
"createdAt": "2025-04-23T19:46:34.831Z",
|
||||
"updatedAt": "2025-04-23T19:46:34.831Z",
|
||||
"isPlatformManagedCredentials": false,
|
||||
"credentialsHash": "7c2d371dec195f82a6a0d5b41c970a229cfcaf88e894a5b6395e2dbd0280661f",
|
||||
"app": "railway",
|
||||
"method": "team-token",
|
||||
"credentials": {}
|
||||
}
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
171
docs/integrations/secret-syncs/railway.mdx
Normal file
171
docs/integrations/secret-syncs/railway.mdx
Normal file
@@ -0,0 +1,171 @@
|
||||
---
|
||||
title: "Railway Sync"
|
||||
description: "Learn how to configure a Railway Sync for Infisical."
|
||||
---
|
||||
|
||||
**Prerequisites:**
|
||||
- Create a [Railway Connection](/integrations/app-connections/railway)
|
||||
|
||||
<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.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Select 'Railway'">
|
||||
|
||||
</Step>
|
||||
<Step title="Configure source">
|
||||
Configure the **Source** from where secrets should be retrieved, then click **Next**.
|
||||
|
||||
|
||||
|
||||
- **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**.
|
||||
|
||||
|
||||
|
||||
- **Railway Connection**: The Railway Connection to authenticate with.
|
||||
- **Project**: The Railway project to sync secrets to.
|
||||
- **Environment**: The Railway environment to sync secrets to.
|
||||
- **Service**: The Service to sync secrets to.
|
||||
- **If not provided**: Secrets will be synced as [shared variables](https://docs.railway.com/guides/variables#shared-variables) on Railway.
|
||||
</Step>
|
||||
<Step title="Configure Sync Options">
|
||||
Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
|
||||
|
||||
|
||||
|
||||
- **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 Railway when keys conflict.
|
||||
- **Import Secrets (Prioritize Railway)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Railway 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 Railway Sync, then click **Next**.
|
||||
|
||||
|
||||
|
||||
- **Name**: The name of your sync. Must be slug-friendly.
|
||||
- **Description**: An optional description for your sync.
|
||||
</Step>
|
||||
<Step title="Review configuration">
|
||||
Review your Railway Sync configuration, then click **Create Sync**.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Sync created">
|
||||
If enabled, your Railway Sync will begin syncing your secrets to the destination endpoint.
|
||||
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
</Tab>
|
||||
<Tab title="API">
|
||||
To create a **Railway Sync**, make an API request to the [Create Railway Sync](/api-reference/endpoints/secret-syncs/railway/create) API endpoint.
|
||||
|
||||
### Sample request
|
||||
|
||||
```bash Request
|
||||
curl --request POST \
|
||||
--url https://app.infisical.com/api/v1/secret-syncs/railway \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
"name": "my-railway-sync",
|
||||
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"description": "an example sync",
|
||||
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"environment": "dev",
|
||||
"secretPath": "/my-secrets",
|
||||
"isEnabled": true,
|
||||
"syncOptions": {
|
||||
"initialSyncBehavior": "overwrite-destination",
|
||||
"autoSyncEnabled": true,
|
||||
"disableSecretDeletion": false
|
||||
},
|
||||
"destinationConfig": {
|
||||
"projectId": "dev-project-id",
|
||||
"projectName": "Development Project",
|
||||
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"environmentName": "Development",
|
||||
"serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"serviceName": "my-railway-service",
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
### Sample response
|
||||
|
||||
```bash Response
|
||||
{
|
||||
"secretSync": {
|
||||
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"name": "my-railway-sync",
|
||||
"description": "an example sync",
|
||||
"isEnabled": true,
|
||||
"version": 1,
|
||||
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"createdAt": "2023-11-07T05:31:56Z",
|
||||
"updatedAt": "2023-11-07T05:31:56Z",
|
||||
"syncStatus": "succeeded",
|
||||
"lastSyncJobId": "123",
|
||||
"lastSyncMessage": null,
|
||||
"lastSyncedAt": "2023-11-07T05:31:56Z",
|
||||
"importStatus": null,
|
||||
"lastImportJobId": null,
|
||||
"lastImportMessage": null,
|
||||
"lastImportedAt": null,
|
||||
"removeStatus": null,
|
||||
"lastRemoveJobId": null,
|
||||
"lastRemoveMessage": null,
|
||||
"lastRemovedAt": null,
|
||||
"syncOptions": {
|
||||
"initialSyncBehavior": "overwrite-destination",
|
||||
"autoSyncEnabled": true,
|
||||
"disableSecretDeletion": false
|
||||
},
|
||||
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"connection": {
|
||||
"app": "railway",
|
||||
"name": "my-railway-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": "/my-secrets"
|
||||
},
|
||||
"destination": "railway",
|
||||
"destinationConfig": {
|
||||
"projectId": "dev-project-id",
|
||||
"projectName": "Development Project",
|
||||
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"environmentName": "Development",
|
||||
"serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
||||
"serviceName": "my-railway-service",
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
Reference in New Issue
Block a user