From e888eed1bff7a0392680303966b926a150d31d61 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Mon, 1 May 2023 16:02:46 +0300 Subject: [PATCH] Add local machine to deployment options --- .env.example | 12 +++++------ README.md | 1 + docs/mint.json | 2 +- docs/self-hosting/overview.mdx | 38 ++++++++++++++++++++++++++++++++++ 4 files changed, 45 insertions(+), 8 deletions(-) diff --git a/.env.example b/.env.example index df316753e..f317b2908 100644 --- a/.env.example +++ b/.env.example @@ -31,13 +31,11 @@ MONGO_PASSWORD=example SITE_URL=http://localhost:8080 # Mail/SMTP -SMTP_HOST= -SMTP_USERNAME= -SMTP_PASSWORD= -SMTP_PORT=587 -SMTP_SECURE=false -SMTP_FROM_ADDRESS= -SMTP_FROM_NAME=Infisical + SMTP_HOST='smtp-server' +SMTP_PORT='1025' +SMTP_NAME='local' +SMTP_USERNAME='team@infisical.com' +SMTP_PASSWORD= # Integration # Optional only if integration is used diff --git a/README.md b/README.md index a19f1df90..1f7d85307 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,7 @@ Windows Command Prompt: git clone https://github.com/Infisical/infisical && cd infisical && copy .env.example .env && docker-compose -f docker-compose.dev.yml up --build ``` +Login to the web app at `http://localhost:8080` by entering the test user email `test@localhost.local` and password `testInfisical1`. ## Open-source vs. paid diff --git a/docs/mint.json b/docs/mint.json index bdecac766..fa6b21576 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -114,7 +114,7 @@ ] }, { - "group": "Self-hosting", + "group": "Deploy Infisical", "pages": [ "self-hosting/overview", "self-hosting/configuration/envars", diff --git a/docs/self-hosting/overview.mdx b/docs/self-hosting/overview.mdx index 8acdad974..d2e076505 100644 --- a/docs/self-hosting/overview.mdx +++ b/docs/self-hosting/overview.mdx @@ -7,6 +7,44 @@ To meet various compliance requirements, you may want to self-host Infisical ins Self-hosted Infisical allows you to maintain your sensitive information within your own infrastructure and network, ensuring complete control over your data. + + ## Setup and launch Infisical + + Make sure you have Git and Docker installed and follow the instructions for your system. + + + + Run the following command to clone, prepare, and start up Infisical: + + ```console + git clone https://github.com/Infisical/infisical && cd "$(basename $_ .git)" && cp .env.example .env && docker-compose -f docker-compose.dev.yml up --build + ``` + + + Run the following command to clone, prepare, and start up Infisical: + + ```console + git clone https://github.com/Infisical/infisical && cd infisical && copy .env.example .env && docker-compose -f docker-compose.dev.yml up --build + ``` + + + Clone the repository back to your machine. + + ```console + git clone https://github.com/Infisical/infisical + ``` + + Navigate into the root of the repository create a new `.env` file containing the contents of the [.env.example file](https://github.com/Infisical/infisical/blob/main/.env.example). + + Finally run `docker-compose up` to start up Infisical. + + ```console + docker-compose -f docker-compose.dev.yml up --build + ``` + + + Login to the web app at `http://localhost:8080` by entering the test user email `test@localhost.local` and password `testInfisical1`. + This deployment option will use AWS Cloudformation to auto deploy an instance of Infisical on a single EC2 via Docker Compose.