From ba9b1b45ae6879d9f5cbd4fc88974fcde8291e55 Mon Sep 17 00:00:00 2001 From: Maidul Islam Date: Fri, 20 Oct 2023 13:36:09 +0100 Subject: [PATCH] update docker docs for self host --- docs/mint.json | 2 +- .../standalone-infisical.mdx | 50 +++++++------------ docs/self-hosting/overview.mdx | 20 ++++---- 3 files changed, 28 insertions(+), 44 deletions(-) diff --git a/docs/mint.json b/docs/mint.json index 9ed8b8ab4..dbe122531 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -141,10 +141,10 @@ "group": "Deployment options", "pages": [ "self-hosting/overview", + "self-hosting/deployment-options/standalone-infisical", "self-hosting/deployment-options/kubernetes-helm", "self-hosting/deployment-options/aws-ec2", "self-hosting/deployment-options/docker-compose", - "self-hosting/deployment-options/standalone-infisical", "self-hosting/deployment-options/digital-ocean-marketplace" ] }, diff --git a/docs/self-hosting/deployment-options/standalone-infisical.mdx b/docs/self-hosting/deployment-options/standalone-infisical.mdx index 881697442..26abf6c93 100644 --- a/docs/self-hosting/deployment-options/standalone-infisical.mdx +++ b/docs/self-hosting/deployment-options/standalone-infisical.mdx @@ -3,11 +3,15 @@ title: "Docker" description: "Learn to install Infisical purely on docker" --- -The Infisical standalone version combines all the essential components of the application into a single container, making deployment and management more straightforward than using Kubernetes or Docker Compose. +The Infisical standalone version combines all the essential components into a single container, making deployment and management more straightforward than other methods. -Since all the components are bundled into one image, running this version of Infisical requires a minimum of **230MB of memory**. +## Prerequisites -This guide assumes you have basic knowledge of Docker and have it installed on your system. If you don't have Docker installed, please follow the official installation guide: https://docs.docker.com/get-docker/ +This guide assumes you have basic knowledge of Docker and have it installed on your system. If you don't have Docker installed, please follow the official installation guide [here](https://docs.docker.com/get-docker/). + +#### System requirements +To have a functional deployment, we recommended compute with **2GB of RAM** and **1 CPU**. +However, depending on your usage, you may need to further scale up system resources to meet demand. ## Pull the Infisical Docker image @@ -18,59 +22,39 @@ docker pull infisical/infisical:latest ``` ## Run with docker -The Infisical Docker image requires several required environment variables. -Add the required environment variables listed below to your docker run command. View [all configurable environment variables](../configuration/envars) - +To run Infisical, we'll need to configure the required configs listed below. +Other configs can be found [here](../configuration/envars) Must be a random 16 byte hex string. Can be generated with `openssl rand -hex 16` - + Must be a random 16 byte hex string. Can be generated with `openssl rand -hex 16` - - Must be a random 16 byte hex string. Can be generated with `openssl rand -hex 16` - - - - Must be a random 16 byte hex string. Can be generated with `openssl rand -hex 16` - - - - Must be a random 16 byte hex string. Can be generated with `openssl rand -hex 16` - - - - Must be a random 16 byte hex string. Can be generated with `openssl rand -hex 16` - - - - Redis connection string - - + A MongoDB connection string. Can use any MongoDB PaaS such as Mongo Atlas, AWS Document DB, etc. *TLS based connection string is not yet supported + + Redis connection string. Only required if you plan to use web integrations. + + Once you have added the required environment variables to your docker run command, execute it in your terminal. ```bash docker run -p 80:8080 \ -e ENCRYPTION_KEY=f40c9178624764ad85a6830b37ce239a \ --e JWT_SIGNUP_SECRET=38ea90fb7998b92176080f457d890392 \ --e JWT_REFRESH_SECRET=7764c7bbf3928ad501591a3e005eb364 \ --e JWT_AUTH_SECRET=5239fea3a4720c0e524f814a540e14a2 \ --e JWT_SERVICE_SECRET=8509fb8b90c9b53e9e61d1e35826dcb5 \ +-e AUTH_SECRET=5239fea3a4720c0e524f814a540e14a2 \ -e MONGO_URL="<>" \ --e REDIS_URL="<>" \ infisical/infisical:latest ``` - The sample environment variables listed above are only to be used as an example and should not be used in production + The above environment variable values are only to be used as an example and should not be used in production ## Verify the installation: diff --git a/docs/self-hosting/overview.mdx b/docs/self-hosting/overview.mdx index 382ae9567..8e72c5c01 100644 --- a/docs/self-hosting/overview.mdx +++ b/docs/self-hosting/overview.mdx @@ -8,11 +8,11 @@ Self-hosted Infisical allows you to maintain your sensitive information within y Choose from a variety of deployment options listed below to get started. - Use our Helm chart to Install Infisical on your Kubernetes cluster + Use the fully packaged docker image to deploy Infisical anywhere - Use the fully packaged, single docker image Infisical to deploy anywhere - + title="Kubernetes" + color="#ea5a0c" + href="deployment-options/kubernetes-helm" +> + Use our Helm chart to Install Infisical on your Kubernetes cluster +