From 335a87d856d92a08f57eb15ca6ea8ded68ed8813 Mon Sep 17 00:00:00 2001 From: Marc Mercer Date: Mon, 28 Oct 2024 13:20:36 -0700 Subject: [PATCH] Think I got them all --- backend/src/db/migrations/20231222172455_integration.ts | 4 ++-- backend/src/ee/services/license/license-service.ts | 2 +- backend/src/services/telemetry/telemetry-queue.ts | 2 +- backend/src/services/telemetry/telemetry-service.ts | 2 +- backend/src/services/telemetry/telemetry-types.ts | 2 +- cli/packages/api/api.go | 2 +- cli/packages/cmd/login.go | 8 ++++---- docs/cli/usage.mdx | 4 ++-- docs/integrations/frameworks/terraform.mdx | 2 +- docs/integrations/platforms/kubernetes.mdx | 2 +- docs/self-hosting/deployment-options/docker-compose.mdx | 4 ++-- .../deployment-options/standalone-infisical.mdx | 2 +- docs/self-hosting/ee.mdx | 2 +- docs/self-hosting/faq.mdx | 4 ++-- 14 files changed, 21 insertions(+), 21 deletions(-) diff --git a/backend/src/db/migrations/20231222172455_integration.ts b/backend/src/db/migrations/20231222172455_integration.ts index 43fd9986a..ad0cec254 100644 --- a/backend/src/db/migrations/20231222172455_integration.ts +++ b/backend/src/db/migrations/20231222172455_integration.ts @@ -9,7 +9,7 @@ export async function up(knex: Knex): Promise { t.uuid("id", { primaryKey: true }).defaultTo(knex.fn.uuid()); t.string("integration").notNullable(); t.string("teamId"); // vercel-specific - t.string("url"); // for self hosted + t.string("url"); // for self-hosted t.string("namespace"); // hashicorp specific t.string("accountId"); // netlify t.text("refreshCiphertext"); @@ -36,7 +36,7 @@ export async function up(knex: Knex): Promise { await knex.schema.createTable(TableName.Integration, (t) => { t.uuid("id", { primaryKey: true }).defaultTo(knex.fn.uuid()); t.boolean("isActive").notNullable(); - t.string("url"); // self hosted + t.string("url"); // self-hosted t.string("app"); // name of app in provider t.string("appId"); t.string("targetEnvironment"); diff --git a/backend/src/ee/services/license/license-service.ts b/backend/src/ee/services/license/license-service.ts index 068d947aa..dc56e7bc3 100644 --- a/backend/src/ee/services/license/license-service.ts +++ b/backend/src/ee/services/license/license-service.ts @@ -129,7 +129,7 @@ export const licenseServiceFactory = ({ } } - // this means this is self hosted oss version + // this means this is the self-hosted oss version // else it would reach catch statement isValidLicense = true; } catch (error) { diff --git a/backend/src/services/telemetry/telemetry-queue.ts b/backend/src/services/telemetry/telemetry-queue.ts index 02e906fe6..c3e5471b0 100644 --- a/backend/src/services/telemetry/telemetry-queue.ts +++ b/backend/src/services/telemetry/telemetry-queue.ts @@ -48,7 +48,7 @@ export const telemetryQueueServiceFactory = ({ await keyStore.deleteItem(TELEMETRY_SECRET_OPERATIONS_KEY); }); - // every day at midnight a telemetry job executes on self hosted + // every day at midnight a telemetry job executes on self-hosted instances // this sends some telemetry information like instance id secrets operated etc const startTelemetryCheck = async () => { // this is a fast way to check its cloud or not diff --git a/backend/src/services/telemetry/telemetry-service.ts b/backend/src/services/telemetry/telemetry-service.ts index 9912e0101..e02cff8a4 100644 --- a/backend/src/services/telemetry/telemetry-service.ts +++ b/backend/src/services/telemetry/telemetry-service.ts @@ -62,7 +62,7 @@ To opt into telemetry, you can set "TELEMETRY_ENABLED=true" within the environme const sendPostHogEvents = async (event: TPostHogEvent) => { if (postHog) { const instanceType = licenseService.getInstanceType(); - // capture posthog only when its cloud or signup event happens in self hosted + // capture posthog only when its cloud or signup event happens in self-hosted if (instanceType === InstanceType.Cloud || event.event === PostHogEventTypes.UserSignedUp) { postHog.capture({ event: event.event, diff --git a/backend/src/services/telemetry/telemetry-types.ts b/backend/src/services/telemetry/telemetry-types.ts index ddeb24211..65fd516f3 100644 --- a/backend/src/services/telemetry/telemetry-types.ts +++ b/backend/src/services/telemetry/telemetry-types.ts @@ -13,7 +13,7 @@ export enum PostHogEventTypes { IntegrationCreated = "Integration Created", MachineIdentityCreated = "Machine Identity Created", UserOrgInvitation = "User Org Invitation", - TelemetryInstanceStats = "Self Hosted Instance Stats" + TelemetryInstanceStats = "Self-Hosted Instance Stats" } export type TSecretModifiedEvent = { diff --git a/cli/packages/api/api.go b/cli/packages/api/api.go index 995385b65..35767cd3f 100644 --- a/cli/packages/api/api.go +++ b/cli/packages/api/api.go @@ -429,7 +429,7 @@ func CallGetRawSecretsV3(httpClient *resty.Client, request GetRawSecretsV3Reques (strings.Contains(response.String(), "bot_not_found_error") || strings.Contains(strings.ToLower(response.String()), "failed to find bot key") || strings.Contains(strings.ToLower(response.String()), "bot is not active")) { - return GetRawSecretsV3Response{}, fmt.Errorf(`Project with id %s is incompatible with your current CLI version. Upgrade your project by visiting the project settings page. If you're self hosting and project upgrade option isn't yet available, contact your administrator to upgrade your Infisical instance to the latest release. + return GetRawSecretsV3Response{}, fmt.Errorf(`Project with id %s is incompatible with your current CLI version. Upgrade your project by visiting the project settings page. If you're self-hosting and project upgrade option isn't yet available, contact your administrator to upgrade your Infisical instance to the latest release. `, request.WorkspaceId) } diff --git a/cli/packages/cmd/login.go b/cli/packages/cmd/login.go index 65e10fe04..03974ba19 100644 --- a/cli/packages/cmd/login.go +++ b/cli/packages/cmd/login.go @@ -236,7 +236,7 @@ var loginCmd = &cobra.Command{ } - //prompt user to select domain between Infisical cloud and self hosting + //prompt user to select domain between Infisical cloud and self-hosting if domainQuery { err = askForDomain() if err != nil { @@ -528,11 +528,11 @@ func DomainOverridePrompt() (bool, error) { func askForDomain() error { - // query user to choose between Infisical cloud or self hosting + // query user to choose between Infisical cloud or self-hosting const ( INFISICAL_CLOUD_US = "Infisical Cloud (US Region)" INFISICAL_CLOUD_EU = "Infisical Cloud (EU Region)" - SELF_HOSTING = "Self Hosting" + SELF_HOSTING = "Self-Hosting" ADD_NEW_DOMAIN = "Add a new domain" ) @@ -609,7 +609,7 @@ func askForDomain() error { return err } - // Trimmed the '/' from the end of the self hosting url, and set the api & login url + // Trimmed the '/' from the end of the self-hosting url, and set the api & login url domain = strings.TrimRight(domain, "/") config.INFISICAL_URL = fmt.Sprintf("%s/api", domain) config.INFISICAL_LOGIN_URL = fmt.Sprintf("%s/login", domain) diff --git a/docs/cli/usage.mdx b/docs/cli/usage.mdx index 3569fd87e..d5b7acb4a 100644 --- a/docs/cli/usage.mdx +++ b/docs/cli/usage.mdx @@ -167,7 +167,7 @@ For security and privacy concerns, we recommend you to configure your terminal t #### Method 2: Export environment variable - You can point the CLI to the self hosted Infisical instance by exporting the environment variable `INFISICAL_API_URL` in your terminal. + You can point the CLI to the self-hosted Infisical instance by exporting the environment variable `INFISICAL_API_URL` in your terminal. @@ -197,7 +197,7 @@ For security and privacy concerns, we recommend you to configure your terminal t #### Method 3: Set manually on every command -Another option to point the CLI to your self hosted Infisical instance is to set it via a flag on every command you run. +Another option to point the CLI to your self-hosted Infisical instance is to set it via a flag on every command you run. ```bash # Example diff --git a/docs/integrations/frameworks/terraform.mdx b/docs/integrations/frameworks/terraform.mdx index dfacfbc57..78bd19558 100644 --- a/docs/integrations/frameworks/terraform.mdx +++ b/docs/integrations/frameworks/terraform.mdx @@ -33,7 +33,7 @@ Set up the Infisical provider by specifying the `host` and `service_token`. Repl ```hcl main.tf provider "infisical" { - host = "https://app.infisical.com" # Only required if using self hosted instance of Infisical, default is https://app.infisical.com + host = "https://app.infisical.com" # Only required if using self-hosted instance of Infisical, default is https://app.infisical.com client_id = "<>" client_secret = "<>" service_token = "<>" # DEPRECATED, USE MACHINE IDENTITY AUTH INSTEAD diff --git a/docs/integrations/platforms/kubernetes.mdx b/docs/integrations/platforms/kubernetes.mdx index bf72122b8..891d422e9 100644 --- a/docs/integrations/platforms/kubernetes.mdx +++ b/docs/integrations/platforms/kubernetes.mdx @@ -169,7 +169,7 @@ spec: ### InfisicalSecret CRD properties - If you are fetching secrets from a self hosted instance of Infisical set the value of `hostAPI` to + If you are fetching secrets from a self-hosted instance of Infisical set the value of `hostAPI` to ` https://your-self-hosted-instace.com/api` When `hostAPI` is not defined the operator fetches secrets from Infisical Cloud. diff --git a/docs/self-hosting/deployment-options/docker-compose.mdx b/docs/self-hosting/deployment-options/docker-compose.mdx index d61879255..440811e65 100644 --- a/docs/self-hosting/deployment-options/docker-compose.mdx +++ b/docs/self-hosting/deployment-options/docker-compose.mdx @@ -2,7 +2,7 @@ title: "Docker Compose" description: "Read how to run Infisical with Docker Compose template." --- -This self hosting guide will walk you though the steps to self host Infisical using Docker compose. +This self-hosting guide will walk you through the steps to self-host Infisical using Docker Compose. ## Prerequisites - [Docker](https://docs.docker.com/engine/install/) @@ -79,4 +79,4 @@ docker-compose -f docker-compose.prod.yml up Your Infisical instance should now be running on port `80`. To access your instance, visit `http://localhost:80`. -![self host sign up](/images/self-hosting/applicable-to-all/selfhost-signup.png) +![self-hosted sign up](/images/self-hosting/applicable-to-all/selfhost-signup.png) diff --git a/docs/self-hosting/deployment-options/standalone-infisical.mdx b/docs/self-hosting/deployment-options/standalone-infisical.mdx index 35beec55c..6e41e4b5f 100644 --- a/docs/self-hosting/deployment-options/standalone-infisical.mdx +++ b/docs/self-hosting/deployment-options/standalone-infisical.mdx @@ -53,7 +53,7 @@ The following guide provides a detailed step-by-step walkthrough on how you can Once the container is running, verify the installation by opening your web browser and navigating to `http://localhost:80`. - ![self host sign up](/images/self-hosting/applicable-to-all/selfhost-signup.png) + ![self-hosted sign up](/images/self-hosting/applicable-to-all/selfhost-signup.png) diff --git a/docs/self-hosting/ee.mdx b/docs/self-hosting/ee.mdx index d77510c11..83b2772e4 100644 --- a/docs/self-hosting/ee.mdx +++ b/docs/self-hosting/ee.mdx @@ -5,7 +5,7 @@ description: "Find out how to activate Infisical Enterprise edition (EE) feature While most features in Infisical are free to use, others are paid and require purchasing an enterprise license to use them. -This guide walks through how you can use these paid features on a self hosted instance of Infisical. +This guide walks through how you can use these paid features on a self-hosted instance of Infisical. diff --git a/docs/self-hosting/faq.mdx b/docs/self-hosting/faq.mdx index db98a23dc..48ea0723c 100644 --- a/docs/self-hosting/faq.mdx +++ b/docs/self-hosting/faq.mdx @@ -3,11 +3,11 @@ title: "FAQ" description: "Frequently Asked Questions about self-hosting Infisical." --- -Frequently asked questions about self hosted instance of Infisical can be found on this page. +Frequently asked questions about self-hosted instance of Infisical can be found on this page. If you can't find the answer you are looking for, please create an issue on our [GitHub repository](https://github.com/Infisical/infisical) or join our [Slack community](https://infisical.com/slack) for additional support. -This issue is typically seen when you haven't set up SSL for your self hosted instance of Infisical. When SSL is not enabled, you can't receive secure cookies, preventing the session data to not be saved. +This issue is typically seen when you haven't set up SSL for your self-hosted instance of Infisical. When SSL is not enabled, you can't receive secure cookies, preventing the session data to not be saved. To fix this, we highly recommend that you set up SSL for your instance. However, in the event you choose to use Infisical without SSL, you can do so by setting the `HTTPS_ENABLED` environment variable to `"false"` for the backend application.