diff --git a/docs/images/self-hosting/deployment-options/railway/railway-create-project.png b/docs/images/self-hosting/deployment-options/railway/railway-create-project.png new file mode 100644 index 000000000..b15e6233b Binary files /dev/null and b/docs/images/self-hosting/deployment-options/railway/railway-create-project.png differ diff --git a/docs/images/self-hosting/deployment-options/railway/railway-deploy-template-infisical.png b/docs/images/self-hosting/deployment-options/railway/railway-deploy-template-infisical.png new file mode 100644 index 000000000..365ac62c9 Binary files /dev/null and b/docs/images/self-hosting/deployment-options/railway/railway-deploy-template-infisical.png differ diff --git a/docs/images/self-hosting/deployment-options/railway/railway-deploy-template.png b/docs/images/self-hosting/deployment-options/railway/railway-deploy-template.png new file mode 100644 index 000000000..7ff29434b Binary files /dev/null and b/docs/images/self-hosting/deployment-options/railway/railway-deploy-template.png differ diff --git a/docs/images/self-hosting/deployment-options/railway/railway-infisical-architecture.png b/docs/images/self-hosting/deployment-options/railway/railway-infisical-architecture.png new file mode 100644 index 000000000..e35f0c7d8 Binary files /dev/null and b/docs/images/self-hosting/deployment-options/railway/railway-infisical-architecture.png differ diff --git a/docs/images/self-hosting/deployment-options/railway/railway-infisical-service.png b/docs/images/self-hosting/deployment-options/railway/railway-infisical-service.png new file mode 100644 index 000000000..1aeaae8e0 Binary files /dev/null and b/docs/images/self-hosting/deployment-options/railway/railway-infisical-service.png differ diff --git a/docs/images/self-hosting/deployment-options/railway/railway-template-infisical.png b/docs/images/self-hosting/deployment-options/railway/railway-template-infisical.png new file mode 100644 index 000000000..19c39a302 Binary files /dev/null and b/docs/images/self-hosting/deployment-options/railway/railway-template-infisical.png differ diff --git a/docs/images/self-hosting/deployment-options/railway/railway-template-mongodb.png b/docs/images/self-hosting/deployment-options/railway/railway-template-mongodb.png new file mode 100644 index 000000000..d65781f4b Binary files /dev/null and b/docs/images/self-hosting/deployment-options/railway/railway-template-mongodb.png differ diff --git a/docs/images/self-hosting/deployment-options/railway/railway-template-overview.png b/docs/images/self-hosting/deployment-options/railway/railway-template-overview.png new file mode 100644 index 000000000..167793890 Binary files /dev/null and b/docs/images/self-hosting/deployment-options/railway/railway-template-overview.png differ diff --git a/docs/images/self-hosting/deployment-options/railway/railway-template-redis.png b/docs/images/self-hosting/deployment-options/railway/railway-template-redis.png new file mode 100644 index 000000000..aa888c43e Binary files /dev/null and b/docs/images/self-hosting/deployment-options/railway/railway-template-redis.png differ diff --git a/docs/mint.json b/docs/mint.json index a90780927..621fff691 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -167,7 +167,8 @@ "self-hosting/deployment-options/azure-app-services", "self-hosting/deployment-options/azure-container-instances", "self-hosting/deployment-options/digital-ocean-marketplace", - "self-hosting/deployment-options/fly.io" + "self-hosting/deployment-options/fly.io", + "self-hosting/deployment-options/railway" ] }, "self-hosting/configuration/envars", diff --git a/docs/self-hosting/deployment-options/railway.mdx b/docs/self-hosting/deployment-options/railway.mdx new file mode 100644 index 000000000..29d2ce293 --- /dev/null +++ b/docs/self-hosting/deployment-options/railway.mdx @@ -0,0 +1,61 @@ +--- +title: "Railway" +description: "Deploy Infisical with Railway" +--- + +Prerequisites: +- Have an account with [Railway](https://railway.app/) + + + + 1.1. In Railway, create a new project and select **Deploy a template > Infisical**. + + ![Railway create project](/images/self-hosting/deployment-options/railway/railway-create-project.png) + + ![Railway deploy template](/images/self-hosting/deployment-options/railway/railway-deploy-template.png) + + ![Railway deploy template infisical](/images/self-hosting/deployment-options/railway/railway-deploy-template-infisical.png) + + ![Railway template overview](/images/self-hosting/deployment-options/railway/railway-template-overview.png) + + 1.2. At minimum, Infisical requires that you set the variables `ENCRYPTION_KEY`, `AUTH_SECRET`, `MONGO_URL`, and `REDIS_URL` + which you can read more about [here](/self-hosting/configuration/envars). + + By default, the Infisical template on Railway pre-configures environment variables on each service in the deployment but requires you to supply two for the Redis and MongoDB services. + + On the MongoDB service, supply a value for the `MONGO_INITDB_ROOT_PASSWORD` variable. + + ![Railway template MongoDB configuration](/images/self-hosting/deployment-options/railway/railway-template-mongodb.png) + + On the Redis service, supply a value for the `REDIS_PASSWORD` variable. + + ![Railway template Redis configuration](/images/self-hosting/deployment-options/railway/railway-template-redis.png) + + ![Railway template Redis configuration](/images/self-hosting/deployment-options/railway/railway-template-redis.png) + + + To use more features like emailing and single sign-on, you can set additional configuration options on the Infisical service [here](/self-hosting/configuration/envars). + + + Finally, press **Deploy** to create the project and deploy the services within it. + + ![Railway template Infisical configuration](/images/self-hosting/deployment-options/railway/railway-template-infisical.png) + + ![Railway Infisical architecture](/images/self-hosting/deployment-options/railway/railway-infisical-architecture.png) + + + Head to the newly-created Infisical service to view its URL under Networking > Public Networking; you can access your instance of Infisical by clicking on the URL. + + ![Railway Infisical service](/images/self-hosting/deployment-options/railway/railway-infisical-service.png) + + + + + + Yes, here are a few that come to mind: + - While the Infisical template on Railway uses the `latest` tag to get the latest version of Infisical, we recommend creating a Railway deployment that pins the Docker image to a specific [version of Infisical](https://hub.docker.com/r/infisical/infisical/tags) to avoid any unexpected version-to-version migration issues. + - We recommend selecting **Deployment region** options for your Railway service deployments to be closest to your infrastructure/clients to reduce latency. + + We're working on putting together a fuller list of deployment best practices as well as minimum resource configuration requirements for running Infisical so stay tuned! + + \ No newline at end of file diff --git a/docs/self-hosting/overview.mdx b/docs/self-hosting/overview.mdx index 5be03714d..f5e754b1f 100644 --- a/docs/self-hosting/overview.mdx +++ b/docs/self-hosting/overview.mdx @@ -1,10 +1,9 @@ --- title: "Introduction" -description: "Explore deployment options for self hosting Infisical" +description: "Self-host Infisical on your own infrastructure" --- -To meet various compliance requirements, you may want to self-host Infisical instead of using [Infisical Cloud](https://app.infisical.com/). -Self-hosted Infisical allows you to maintain your sensitive information within your own infrastructure and network, ensuring complete control over your data. +Self-hosting Infisical lets you retain data on your own infrastructure and network. Choose from a variety of deployment options listed below to get started. Deploy Infisical with AWS Lightsail - - Deploy Infisical with Fly.io - Deploy Infisical with Azure Container Instances + + Deploy Infisical with Fly.io + + + Deploy Infisical with Railway +