Slack |
- Infisical Cloud |
+ Infisical Cloud |
Self-Hosting |
Docs |
Website
@@ -21,6 +21,9 @@
+
+
+
@@ -30,12 +33,12 @@
**[Infisical](https://infisical.com)** is an open source, E2EE tool to help teams manage and sync environment variables across their development workflow and infrastructure. It's designed to be simple and take minutes to get going.
-- **User-Friendly Dashboard** to manage your team's environment variables within projects
+- **[User-Friendly Dashboard](https://infisical.com/docs/getting-started/dashboard/project)** to manage your team's environment variables within projects
- **[Language-Agnostic CLI](https://infisical.com/docs/cli/overview)** that pulls and injects environment variables into your local workflow
- **[Complete control over your data](https://infisical.com/docs/self-hosting/overview)** - host it yourself on any infrastructure
- **Navigate Multiple Environments** per project (e.g. development, staging, production, etc.)
- **Personal/Shared** scoping for environment variables
-- **[Integrations](https://infisical.com/docs/integrations/heroku)** with CI/CD and production infrastructure (Heroku available, more coming soon)
+- **[Integrations](https://infisical.com/docs/integrations/overview)** with CI/CD and production infrastructure (Heroku available, more coming soon)
- π **1-Click Deploy** to Digital Ocean and Heroku
- π **Authentication/Authorization** for projects (read/write controls soon)
- π **Automatic Secret Rotation**
@@ -51,15 +54,13 @@ To quickly get started, visit our [get started guide](https://infisical.com/docs
## What's cool about this?
-Infisical is simple, E2EE, and (soon to be) complete.
+Infisical makes secret management simple and end-to-end encrypted by default. We're on a mission to make it more accessible to all developers, not just security teams.
According to a [report](https://www.ekransystem.com/en/blog/secrets-management) in 2019, only 10% of organizations use secret management solutions despite all using digital secrets to some extent.
-We're on a mission to make secret management more accessible to everyone β that means building for developers, not just security teams.
-
If you care about efficiency and security, then Infisical is right for you.
-Need any integrations or want a new feature? Feel free to [create an issue](https://github.com/Infisical/infisical/issues) or [contribute](https://infisical.com/docs/contributing/overview) directly to the repository.
+We are currently working hard to make Infisical more extensive. Need any integrations or want a new feature? Feel free to [create an issue](https://github.com/Infisical/infisical/issues) or [contribute](https://infisical.com/docs/contributing/overview) directly to the repository.
## Contributing
@@ -69,9 +70,10 @@ Not sure where to get started? [Book a free, non-pressure pairing sessions with
## Community & Support
-- [GitHub Discussions](https://github.com/Infisical/infisical/discussions) for help with building and discussion.
-- [GitHub Issues](https://github.com/Infisical/infisical-cli/issues) for any bugs and errors you encounter using Infisical.
-- [Community Slack](https://join.slack.com/t/infisical-users/shared_invite/zt-1kdbk07ro-RtoyEt_9E~fyzGo_xQYP6g) for hanging out with the community and quick communication with the team.
+- [Slack](https://join.slack.com/t/infisical-users/shared_invite/zt-1kdbk07ro-RtoyEt_9E~fyzGo_xQYP6g) (For live discussion with the community and the Infisical team)
+- [GitHub Discussions](https://github.com/Infisical/infisical/discussions) (For help with building and deeper conversations about features)
+- [GitHub Issues](https://github.com/Infisical/infisical-cli/issues) (For any bugs and errors you encounter using Infisical)
+- [Twitter](https://twitter.com/infisical) (Get news fast)
## Status
@@ -89,23 +91,179 @@ Infisical officially launched as v.1.0 on November 21st, 2022. However, a lot of
## Integrations
-We're currently setting the foundation and building integrations so secrets can be synced everywhere. Any help is welcome! :)
+We're currently setting the foundation and building [integrations](https://infisical.com/docs/integrations/overview) so secrets can be synced everywhere. Any help is welcome! :)
+
+
-- [x] [Docker](https://infisical.com/docs/integrations/docker)
-- [x] [Docker Compose](https://infisical.com/docs/integrations/docker-compose)
-- [x] [Heroku](https://infisical.com/docs/integrations/heroku)
-- [ ] Vercel
-- [ ] Kubernetes
-- [ ] AWS
-- [ ] GCP
-- [ ] Azure
-- [ ] Digital Ocean
-- [ ] GitLab
-- [ ] CircleCI
## Open-source vs. paid
-This repo is entirely MIT licensed, with the exception of the `ee` directory which will contain premium enterprise features requring a Infisical license in the future. We're currently focused on developing non-enterprise offerings first that should suit most use-cases.
+This repo is entirely MIT licensed, with the exception of the `ee` directory which will contain premium enterprise features requiring a Infisical license in the future. We're currently focused on developing non-enterprise offerings first that should suit most use-cases.
## Security
@@ -119,4 +277,4 @@ Looking to report a security vulnerability? Please don't post about it in GitHub
-
+
diff --git a/backend/package.json b/backend/package.json
index 9dfe476e9..2bd296d9c 100644
--- a/backend/package.json
+++ b/backend/package.json
@@ -22,8 +22,6 @@
"query-string": "^7.1.1",
"rimraf": "^3.0.2",
"stripe": "^10.7.0",
- "swagger-jsdoc": "^6.2.5",
- "swagger-ui-express": "^4.6.0",
"tweetnacl": "^1.0.3",
"tweetnacl-util": "^0.15.1",
"typescript": "^4.8.4"
diff --git a/backend/src/helpers/signup.ts b/backend/src/helpers/signup.ts
index 410c442b3..e26b9b360 100644
--- a/backend/src/helpers/signup.ts
+++ b/backend/src/helpers/signup.ts
@@ -106,7 +106,7 @@ const initializeDefaultOrg = async ({
// initialize a default workspace inside the new organization
const workspace = await createWorkspace({
- name: `${user.firstName}'s Project`,
+ name: `Example Project`,
organizationId: organization._id.toString()
});
diff --git a/backend/src/index.ts b/backend/src/index.ts
index 1bc596865..a5ae44969 100644
--- a/backend/src/index.ts
+++ b/backend/src/index.ts
@@ -4,8 +4,6 @@ import cors from 'cors';
import cookieParser from 'cookie-parser';
import mongoose from 'mongoose';
import dotenv from 'dotenv';
-import swaggerJSDoc from 'swagger-jsdoc';
-import swaggerUi from 'swagger-ui-express';
dotenv.config();
import * as Sentry from '@sentry/node';
@@ -68,39 +66,6 @@ if (NODE_ENV === 'production') {
app.use(helmet());
}
-if (NODE_ENV === 'development') {
- const swaggerDefinition = {
- openapi: '3.0.0',
- info: {
- title: 'Infisical API',
- version: '1.0.0',
- description: 'Infisical is an open-source, E2EE tool to sync environment variables across your team and infrastructure.',
- license: {
- name: 'License',
- url: 'https://github.com/Infisical/infisical/blob/main/LICENSE'
- },
- contact: {
- name: 'Infisical',
- url: 'https://infisical.com'
- },
- },
- servers: [
- {
- url: 'http://localhost:8080/api/v1',
- description: 'Development server'
- }
- ]
- }
-
- const options = {
- swaggerDefinition,
- apis: ['./src/routes/*.ts']
- }
-
- const swaggerSpec = swaggerJSDoc(options);
- app.use('/api/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
-}
-
app.use(express.json());
// routers
diff --git a/backend/src/routes/auth.ts b/backend/src/routes/auth.ts
index 52cd6ac48..43a57fe7e 100644
--- a/backend/src/routes/auth.ts
+++ b/backend/src/routes/auth.ts
@@ -11,53 +11,6 @@ router.post(
authController.getNewToken
);
-/**
- * @swagger
- * /auth/login1:
- * post:
- * summary: Return server's public key and user's salt for login via SRP.
- * description: As part of the 1st step of secure remote password (SRP), return server's public key and user's salt.
- * requestBody:
- * required: true
- * content:
- * application/json:
- * schema:
- * type: object
- * properties:
- * email:
- * type: string
- * description: Email of user
- * example: 'johndoe@gmail.com'
- * clientPublicKey:
- * type: string
- * description: Client-side SRP-generated public key
- * example: 'b13dc83cb...'
- * responses:
- * 200:
- * description: Object containing the server's public key and user's salt.
- * content:
- * application/json:
- * schema:
- * type: object
- * properties:
- * serverPublicKey:
- * type: string
- * description: Server-side SRP-generated public key
- * example: 'b13dc83cb...'
- * salt:
- * type: string
- * description: User's salt
- * example: 'dc1ac694f...'
- * 400:
- * content:
- * application/json:
- * schema:
- * type: object
- * properties:
- * message:
- * type: string
- * example: 'Failed to start authentication process'
- */
router.post(
'/login1',
loginLimiter,
diff --git a/cli/packages/cmd/root.go b/cli/packages/cmd/root.go
index 826ccb4df..42d85e5b2 100644
--- a/cli/packages/cmd/root.go
+++ b/cli/packages/cmd/root.go
@@ -15,7 +15,7 @@ var rootCmd = &cobra.Command{
Short: "Infisical CLI is used to inject environment variables into any process",
Long: `Infisical is a simple, end-to-end encrypted service that enables teams to sync and manage their environment variables across their development life cycle.`,
CompletionOptions: cobra.CompletionOptions{DisableDefaultCmd: true},
- Version: "0.1.5",
+ Version: "0.1.6",
}
// Execute adds all child commands to the root command and sets flags appropriately.
diff --git a/docs/cli/overview.mdx b/docs/cli/overview.mdx
index bbe86d379..8411b8e75 100644
--- a/docs/cli/overview.mdx
+++ b/docs/cli/overview.mdx
@@ -95,3 +95,9 @@ The Infisical CLI provides a way to inject environment variables from the platfo
+
+## Log in to the Infisical CLI
+
+```bash
+infisical login
+```
diff --git a/docs/cli/token.mdx b/docs/cli/token.mdx
index 043f07431..5b3d2fd6b 100644
--- a/docs/cli/token.mdx
+++ b/docs/cli/token.mdx
@@ -12,8 +12,8 @@ The CLI looks out for an environment variable called the `INFISICAL_TOKEN` which
A common use-case is to use the Infisical Token to fetch environment variables with Docker. More specifically, a token can be passed to a container as an environment variable for the CLI to authenticate and pull its corresponding secrets. Check out the integration guides for that:
-- [Docker](../../integrations/docker)
-- [Docker Compose](../../integrations/docker-compose)
+- [Docker](../../integrations/platforms/docker)
+- [Docker Compose](../../integrations/platforms/docker-compose)
Once the token is expired, the CLI using it will no longer be able to make
diff --git a/docs/cli/usage.mdx b/docs/cli/usage.mdx
index ea7180068..4237f8154 100644
--- a/docs/cli/usage.mdx
+++ b/docs/cli/usage.mdx
@@ -4,12 +4,6 @@ title: "Usage"
Prerequisite: [Install the CLI](/cli/overview)
-## Log in to the Infisical CLI
-
-```bash
-infisical login
-```
-
## Initialize Infisical for your project
```bash
@@ -29,11 +23,11 @@ infisical run -- [your application start command]
Options you can specify:
-| Option | Description | Default value |
-| ------------- | ----------------------------------------------------------------------------------------------------------- | ------------- |
-| `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` |
-| `--projectId` | Used to link a local project to the platform (required only if injecting via the service token method) | `None` |
-| `--expand` | Parse shell parameter expansions in your secrets (e.g., `${DOMAIN}`) | `true` |
+| Option | Description | Default value |
+| ------------- | ----------------------------------------------------------------------------------------------------------- | ------------- |
+| `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` |
+| `--projectId` | Used to link a local project to the platform (required only if injecting via the service token method) | `None` |
+| `--expand` | Parse shell parameter expansions in your secrets (e.g., `${DOMAIN}`) | `true` |
## Examples:
diff --git a/docs/contributing/FAQ.mdx b/docs/contributing/FAQ.mdx
new file mode 100644
index 000000000..be65f5ca7
--- /dev/null
+++ b/docs/contributing/FAQ.mdx
@@ -0,0 +1,16 @@
+---
+title: "Frequently Asked Questions"
+description: "Have any questions? [Join our Slack community](https://join.slack.com/t/infisical-users/shared_invite/zt-1kdbk07ro-RtoyEt_9E~fyzGo_xQYP6g)."
+---
+
+## Problem with SMTP
+
+You can normally populate `SMTP_USERNAME` and `SMTP_PASSWORD` with your usual login and password (you could also create a 'burner' email). Sometimes, there still are problems.
+
+You can go to your Gmail account settings > security and enable βless secure appsβ. This would allow Infisical to use your Gmail to send emails.
+
+If it still doesn't work, [this](https://stackoverflow.com/questions/72547853/unable-to-send-email-in-c-sharp-less-secure-app-access-not-longer-available/72553362#72553362) should help.
+
+## `MONGO_URL` issues
+
+Your `MONGO_URL` should be something like `mongodb://root:example@mongo:27017/?authSource=admin`. If you want to change it (not recommended), you should make sure that you keep this URL in line with `MONGO_USERNAME=root` and `MONGO_PASSWORD=example`.
\ No newline at end of file
diff --git a/docs/contributing/developing.mdx b/docs/contributing/developing.mdx
index cca804a9c..b6c25861c 100644
--- a/docs/contributing/developing.mdx
+++ b/docs/contributing/developing.mdx
@@ -16,7 +16,7 @@ cd infisical
## Set up environment variables
-Tweak the `.env` according to your preferences. Refer to the available [environment variables](envars).
+Tweak the `.env` according to your preferences. Refer to the available [environment variables](/self-hosting/configuration/envars).
```bash
cp .env.example .env
diff --git a/docs/getting-started/dashboard/create-account.mdx b/docs/getting-started/dashboard/create-account.mdx
index ea412c1e7..ddc1654e3 100644
--- a/docs/getting-started/dashboard/create-account.mdx
+++ b/docs/getting-started/dashboard/create-account.mdx
@@ -8,24 +8,7 @@ If you're using a self-hosted installation, follow the [setup](/self-hosting/ove
## Infisical Cloud
-**Step 1:** Open [infisical.com](https://infisical.com/) and click on either "Try Infisical for free" or "Start for free" to head to the signup sequence.
-
-
-
-**Step 2:** Fill out the signup sequence.
-
-
-
-
-
-You'll be prompted to fill out some required fields to set up your account.
-
-| Field | Description |
-| ---------- | --------------------------- |
-| Email | Enter a valid email address |
-| First name | Your first name |
-| Last name | Your last name |
-| Password | Password |
+Open [infisical.com](https://infisical.com/) and click on either "Try Infisical for free" or "Start for free" to complete the signup sequence.
Once you've done that, you'll be taken to the dashboard where we've populated some default environment variables for demonstration.
diff --git a/docs/getting-started/dashboard/integrations.mdx b/docs/getting-started/dashboard/integrations.mdx
index 193cde84b..95541ca38 100644
--- a/docs/getting-started/dashboard/integrations.mdx
+++ b/docs/getting-started/dashboard/integrations.mdx
@@ -2,12 +2,10 @@
title: "Integrations"
---
-Weβre still early with integrations but youβll be able to sync environment variables across your entire infrastructure from local development to CI/CD and production.
+Integrations allow environment variables to be synced across your entire infrastructure from local development to CI/CD and production.
+
+We're still early with integrations, but expect more soon.
-Check out integrations:
-
-- [Heroku](/integrations/heroku)
-- [Docker](/integrations/docker)
-- [Docker Compose](/integrations/docker-compose)
+Check out our [integrations](/integrations/overview).
diff --git a/docs/getting-started/dashboard/organization.mdx b/docs/getting-started/dashboard/organization.mdx
index 7cbd642fe..c58922daa 100644
--- a/docs/getting-started/dashboard/organization.mdx
+++ b/docs/getting-started/dashboard/organization.mdx
@@ -2,15 +2,12 @@
title: "Organization"
---
-By default, Infisical creates an organization under your name such as "John's Organization." To make changes and add members to your organization, head to your organization settings.
+An organization houses projects and members.
-
+By default, Infisical creates an organization under your name. You can manage your organization in your organization settings.
-
-
-
-Feel free to change the name of your organization.
+
## Members
@@ -19,9 +16,12 @@ Members of an organization can create and add other members to projects within t
To add a member to your organization, scroll down to the "Organization Members" section and invite the member via email. They'll receive an email to confirm their organization invitation. If the member is an existing user on the platform, they will be automatically added to the organization.
-
-Note that access to projects must be provisioned to new members after they've accepted their invitation, and they will not be added to any projects by default.
+
+ Note that access to projects must be provisioned to new members after they've
+ accepted their organization invitation, and they will not be added to any
+ projects by default.
+
## Incident contacts
@@ -30,4 +30,3 @@ Incident contacts of an organization are alerted if anything abnormal is detecte
To add an incident contact to your organization, scroll down to the "Incident Contacts" section and add their email.
-
diff --git a/docs/getting-started/dashboard/project.mdx b/docs/getting-started/dashboard/project.mdx
index b385f09d8..aa64d635b 100644
--- a/docs/getting-started/dashboard/project.mdx
+++ b/docs/getting-started/dashboard/project.mdx
@@ -2,7 +2,7 @@
title: "Project"
---
-A project houses environment variables for an application or service.
+A project houses environment variables for an application.
## Dashboard
@@ -33,20 +33,14 @@ Every environment variable is classified as either personal or shared.
You can toggle the classification of an environment variable by pressing on its settings:
-
-
-
-
### Search
You can search for any environment variable by its key.
-
-
### Sort
You can sort environment variables alphabetically by their keys.
@@ -59,8 +53,6 @@ You can hide or un-hide the values of your environment variables. By default, th
-
-
### Download as .env
You can download your environment variables back in a .env file.
diff --git a/docs/getting-started/dashboard/token.mdx b/docs/getting-started/dashboard/token.mdx
index 121578417..85f46b799 100644
--- a/docs/getting-started/dashboard/token.mdx
+++ b/docs/getting-started/dashboard/token.mdx
@@ -2,20 +2,15 @@
title: "Infisical Token"
---
-An Infisical Token is needed to authenticate the CLI when there isn't an easy way to manually type in your login credentials to sync environment variables to your applications.
+An Infisical Token is needed to authenticate the CLI when there isn't an easy way to input your login credentials.
-It grants read-only access to a particular environment and project for a specified amount of time.
+It's useful for the [Docker](/integrations/platforms/docker) and [Docker Compose](/integrations/platforms/docker-compose) integrations.
-This is useful in the following contexts:
-
-- [Docker](/integrations/docker)/[Docker-Compose](/integrations/docker-compose) integration: An Infisical Token can be passed to a Docker container as an environment variable for the CLI to authenticate and pull its corresponding secrets.
-
-## Generate an Infisical Token
-
-It's possible to generate an Infisical token in the settings of a project.
+It's possible to generate the token in the settings of a project.
-
-
-
+
+ The token grants read-only access to a particular environment and project for
+ a specified amount of time.
+
diff --git a/docs/getting-started/introduction.mdx b/docs/getting-started/introduction.mdx
index 5f5d2a44d..72b86bf05 100644
--- a/docs/getting-started/introduction.mdx
+++ b/docs/getting-started/introduction.mdx
@@ -27,7 +27,7 @@ Start syncing environment variables with [Infisical Cloud](https://app.infisical
Learn how to configure and deploy Infisical.
+ Note that for environment variables to be exposed to the client, you'll have
+ to prefix them with `GATSBY_`. Read more about that
+ [here](https://www.gatsbyjs.com/docs/how-to/local-development/environment-variables/#accessing-environment-variables-in-the-browser).
+
diff --git a/docs/integrations/frameworks/laravel.mdx b/docs/integrations/frameworks/laravel.mdx
new file mode 100644
index 000000000..0dfb219aa
--- /dev/null
+++ b/docs/integrations/frameworks/laravel.mdx
@@ -0,0 +1,10 @@
+---
+title: "Laravel"
+---
+
+Prerequisites:
+
+- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
+- [Install the CLI](/cli/overview)
+
+Instructions coming soon.
diff --git a/docs/integrations/frameworks/nestjs.mdx b/docs/integrations/frameworks/nestjs.mdx
new file mode 100644
index 000000000..8283b1175
--- /dev/null
+++ b/docs/integrations/frameworks/nestjs.mdx
@@ -0,0 +1,50 @@
+---
+title: "NestJS"
+---
+
+Prerequisites:
+
+- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
+- [Install the CLI](/cli/overview)
+
+## Initialize Infisical for your [NestJS](https://nestjs.com) app
+
+```bash
+# move to your Next.js app
+cd /path/to/project
+
+# initialize infisical
+infisical init
+```
+
+## Modify the start script in your `package.json`
+
+```json
+...
+"scripts": {
+ "prebuild": "rimraf dist",
+ "build": "nest build",
+ "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+ "start": "infisical run -- nest start",
+ "start:dev": "infisical run -- nest start --watch",
+ "start:debug": "nest start --debug --watch",
+ "start:prod": "node dist/main",
+ "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+ "test": "jest",
+ "test:watch": "jest --watch",
+ "test:cov": "jest --coverage",
+ "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+ "test:e2e": "jest --config ./test/jest-e2e.json"
+}
+...
+```
+
+## Start your server with environment variables injected
+
+```bash
+npm run start
+
+# or start development server
+
+npm run start:dev
+```
diff --git a/docs/integrations/frameworks/nextjs.mdx b/docs/integrations/frameworks/nextjs.mdx
new file mode 100644
index 000000000..a70cf6e41
--- /dev/null
+++ b/docs/integrations/frameworks/nextjs.mdx
@@ -0,0 +1,46 @@
+---
+title: "Next.js"
+---
+
+Prerequisites:
+
+- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
+- [Install the CLI](/cli/overview)
+
+## Initialize Infisical for your [Next.js](https://nextjs.org) app
+
+```bash
+# move to your Next.js app
+cd /path/to/project
+
+# initialize infisical
+infisical init
+```
+
+## Modify the start script in your `package.json`
+
+```json
+...
+"scripts": {
+ "dev": "infisical run -- next dev",
+ "build": "infisical run -- next build",
+ "start": "infisical run -- next start"
+}
+...
+```
+
+## Start your server with environment variables injected
+
+```bash
+npm run build && npm run start
+
+# or start development server
+
+npm run dev
+```
+
+
+ Note that for environment variables to be exposed to the client, you'll have
+ to prefix them with `NEXT_PUBLIC_`. Read more about that
+ [here](https://nextjs.org/docs/basic-features/environment-variables).
+
diff --git a/docs/integrations/frameworks/nuxt.mdx b/docs/integrations/frameworks/nuxt.mdx
new file mode 100644
index 000000000..901ec35a5
--- /dev/null
+++ b/docs/integrations/frameworks/nuxt.mdx
@@ -0,0 +1,36 @@
+---
+title: "Nuxt"
+---
+
+Prerequisites:
+
+- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
+- [Install the CLI](/cli/overview)
+
+## Initialize Infisical for your [Nuxt](https://nuxtjs.org) app
+
+```bash
+# move to your Nuxt app
+cd /path/to/project
+
+# initialize infisical
+infisical init
+```
+
+## Modify the start script in your `package.json`
+
+```json
+...
+"scripts": {
+ "dev": "infisical run -- nuxt",
+ "build": "infisical run -- nuxt build",
+ "start": "infisical run -- nuxt start"
+}
+...
+```
+
+## Start your development server with environment variables injected
+
+```bash
+npm run dev
+```
diff --git a/docs/integrations/frameworks/rails.mdx b/docs/integrations/frameworks/rails.mdx
new file mode 100644
index 000000000..7e08bffa7
--- /dev/null
+++ b/docs/integrations/frameworks/rails.mdx
@@ -0,0 +1,24 @@
+---
+title: "Ruby on Rails"
+---
+
+Prerequisites:
+
+- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
+- [Install the CLI](/cli/overview)
+
+## Initialize Infisical for your [Rails](https://rubyonrails.org) app
+
+```bash
+# move to your Rails app
+cd /path/to/project
+
+# initialize infisical
+infisical init
+```
+
+## Start your server with environment variables injected
+
+```bash
+infisical run -- bin/rails server
+```
diff --git a/docs/integrations/frameworks/react.mdx b/docs/integrations/frameworks/react.mdx
new file mode 100644
index 000000000..950505432
--- /dev/null
+++ b/docs/integrations/frameworks/react.mdx
@@ -0,0 +1,37 @@
+---
+title: "React"
+---
+
+Prerequisites:
+
+- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
+- [Install the CLI](/cli/overview)
+
+## Initialize Infisical for your [Create React App](https://create-react-app.dev)
+
+```bash
+# move to your React app
+cd /path/to/project
+
+# initialize infisical
+infisical init
+```
+
+## Modify the start script in your `package.json`
+
+```json
+...
+"scripts": {
+ "start": "infisical run -- react-scripts start",
+ "build": "react-scripts build",
+ "test": "react-scripts test",
+ "eject": "react-scripts eject"
+}
+...
+```
+
+## Start your server with environment variables injected
+
+```bash
+npm start
+```
diff --git a/docs/integrations/frameworks/remix.mdx b/docs/integrations/frameworks/remix.mdx
new file mode 100644
index 000000000..aa9956005
--- /dev/null
+++ b/docs/integrations/frameworks/remix.mdx
@@ -0,0 +1,41 @@
+---
+title: "Remix"
+---
+
+Prerequisites:
+
+- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
+- [Install the CLI](/cli/overview)
+
+## Initialize Infisical for your [Remix](https://remix.run) app
+
+```bash
+# move to your Vue app
+cd /path/to/project
+
+# initialize infisical
+infisical init
+```
+
+## Modify the start script in your `package.json`
+
+```json
+...
+"scripts": {
+ ...
+ "dev": "infisical run -- run-p dev:*",
+ "start": "infisical run -- remix-serve build"
+ ...
+}
+...
+```
+
+## Start your server with environment variables injected
+
+```bash
+npm run build && npm run start
+
+# or start development server
+
+npm run dev
+```
diff --git a/docs/integrations/frameworks/vite.mdx b/docs/integrations/frameworks/vite.mdx
new file mode 100644
index 000000000..251924ca7
--- /dev/null
+++ b/docs/integrations/frameworks/vite.mdx
@@ -0,0 +1,43 @@
+---
+title: "Vite"
+---
+
+Prerequisites:
+
+- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
+- [Install the CLI](/cli/overview)
+
+## Initialize Infisical for your [Vite](https://vitejs.dev) app
+
+```bash
+# move to your Vite app
+cd /path/to/project
+
+# initialize infisical
+infisical init
+```
+
+## Modify the start script in your `package.json`
+
+```json
+...
+"scripts": {
+ "dev": "infisical run -- vite",
+ "build": "infisical run -- vite build",
+ "preview": "infisical run -- vite preview"
+}
+...
+```
+
+## Start your development server with environment variables injected
+
+```bash
+npm run dev
+```
+
+
+ Note that for environment variables to be exposed to the client, you'll have
+ to prefix them with `VITE_` and export them from the `vite.config.js` file.
+ Read more about that [here](https://vitejs.dev/guide/env-and-mode.html) and
+ [here](https://main.vitejs.dev/config).
+
diff --git a/docs/integrations/frameworks/vue.mdx b/docs/integrations/frameworks/vue.mdx
new file mode 100644
index 000000000..15c4a12cf
--- /dev/null
+++ b/docs/integrations/frameworks/vue.mdx
@@ -0,0 +1,42 @@
+---
+title: "Vue"
+---
+
+Prerequisites:
+
+- Set up and add envars to [Infisical Cloud](https://app.infisical.com)
+- [Install the CLI](/cli/overview)
+
+## Initialize Infisical for your [Vue](https://vuejs.org) app
+
+```bash
+# move to your Vue app
+cd /path/to/project
+
+# initialize infisical
+infisical init
+```
+
+## Modify the start script in your `package.json`
+
+```json
+...
+"scripts": {
+ "serve": "infisical run -- vue-cli-service serve",
+ "build": "infisical run -- vue-cli-service build",
+ "lint": "infisical run -- vue-cli-service lint"
+}
+...
+```
+
+## Start your development server with environment variables injected
+
+```bash
+npm run serve
+```
+
+
+ Note that for environment variables to be exposed to the client, you'll have
+ to prefix them with `VUE_APP` Read more about that
+ [here](https://cli.vuejs.org/guide/mode-and-env.html).
+
diff --git a/docs/integrations/overview.mdx b/docs/integrations/overview.mdx
index 4f4a2db3e..17c7a7f72 100644
--- a/docs/integrations/overview.mdx
+++ b/docs/integrations/overview.mdx
@@ -2,23 +2,37 @@
title: "Overview"
---
-Integrations allow environment variables to be synced across your entire infrastructure from local development to CI/CD and production.
+Integrations allow environment variables to be synced from Infisical into your local development workflow, CI/CD pipelines, and production infrastructure.
Missing an integration? Throw in a [request](https://github.com/Infisical/infisical/issues).
-| Integration | Status |
-| ---------------------------------------------- | ----------- |
-| [Docker](/integrations/docker) | Available |
-| [Docker-Compose](/integrations/docker-compose) | Available |
-| [Heroku](/integrations/heroku) | Available |
-| Kubernetes | Coming soon |
-| Vercel | Coming soon |
-| AWS | Coming soon |
-| GCP | Coming soon |
-| Azure | Coming soon |
-| DigitalOcean | Coming soon |
-| GitLab | Coming soon |
-| CircleCI | Coming soon |
-| TravisCI | Coming soon |
-| GitHub Actions | Coming soon |
-| Jenkins | Coming soon |
+| Integration | Type | Status |
+| -------------------------------------------------------- | --------- | ----------- |
+| [Docker](/integrations/platforms/docker) | Platform | Available |
+| [Docker-Compose](/integrations/platforms/docker-compose) | Platform | Available |
+| Kubernetes | Platform | Coming soon |
+| [Heroku](/integrations/cloud/heroku) | Cloud | Available |
+| Vercel | Cloud | Coming soon |
+| AWS | Cloud | Coming soon |
+| GCP | Cloud | Coming soon |
+| Azure | Cloud | Coming soon |
+| DigitalOcean | Cloud | Coming soon |
+| GitLab | CI/CD | Coming soon |
+| CircleCI | CI/CD | Coming soon |
+| TravisCI | CI/CD | Coming soon |
+| GitHub Actions | CI/CD | Coming soon |
+| Jenkins | CI/CD | Coming soon |
+| [React](/integrations/frameworks/react) | Framework | Available |
+| [Vue](/integrations/frameworks/vue) | Framework | Available |
+| [Express](/integrations/frameworks/express) | Framework | Available |
+| [Next.js](/integrations/frameworks/nextjs) | Framework | Available |
+| [NestJS](/integrations/frameworks/nestjs) | Framework | Available |
+| [Nuxt](/integrations/frameworks/nuxt) | Framework | Available |
+| [Gatsby](/integrations/frameworks/gatsby) | Framework | Available |
+| [Remix](/integrations/frameworks/remix) | Framework | Available |
+| [Vite](/integrations/frameworks/vite) | Framework | Available |
+| [Fiber](/integrations/frameworks/fiber) | Framework | Coming soon |
+| [Django](/integrations/frameworks/django) | Framework | Available |
+| [Flask](/integrations/frameworks/flask) | Framework | Available |
+| [Laravel](/integrations/frameworks/laravel) | Framework | Coming soon |
+| [Ruby on Rails](/integrations/frameworks/rails) | Framework | Available |
diff --git a/docs/integrations/docker-compose.mdx b/docs/integrations/platforms/docker-compose.mdx
similarity index 84%
rename from docs/integrations/docker-compose.mdx
rename to docs/integrations/platforms/docker-compose.mdx
index 97ce0aba0..9e0f90e55 100644
--- a/docs/integrations/docker-compose.mdx
+++ b/docs/integrations/platforms/docker-compose.mdx
@@ -2,11 +2,13 @@
title: "Docker Compose"
---
-### Step 1: Add CLI to your Dockerfile
+The Docker Compose integration enables you to inject environment variables from Infisical into the containers defined in your compose file.
-Follow steps 1 through 3 on our [guide to configure Infisical CLI](../getting-started/cli/installation) in your Dockerfile.
+## Add the CLI to your Dockerfile(s)
-### Step 2: Generate Infisical Token
+Follow steps 1 through 3 on our [guide to configure Infisical CLI](../integrations/platforms/docker) in your Dockerfile.
+
+## Generate Infisical Token
In order for Infisical CLI to authenticate and retrieve your project's secrets without exposing your login credentials, you must generate a Infisical Token.
To learn how, visit [Infisical Token](../getting-started/cli/infisical-token). Once you have generated the token, keep it handy.
@@ -16,7 +18,7 @@ To learn how, visit [Infisical Token](../getting-started/cli/infisical-token). O
have to generate a Infisical Token for each service.
-### Step 3: Tell Docker Compose your Infisical Token
+## Tell Docker Compose your Infisical Token
For each service you want to inject secrets into, set an environment variable called `INFISICAL_TOKEN` equal to a helpful identifier variable.
This will ensure that you can set Infisical Tokens for multiple services.
@@ -41,7 +43,7 @@ services:
- INFISICAL_TOKEN=${INFISICAL_TOKEN_FOR_API}
```
-### 4: Export shell variables
+## Export shell variables
Next, set the shell variables you defined in your compose file. This can be done manually or via your CI/CD environment. Once done, it will be used to populate the corresponding `INFISICAL_TOKEN`
in your Docker Compose file.
diff --git a/docs/integrations/docker.mdx b/docs/integrations/platforms/docker.mdx
similarity index 69%
rename from docs/integrations/docker.mdx
rename to docs/integrations/platforms/docker.mdx
index aad94ae6c..6f08c9ec8 100644
--- a/docs/integrations/docker.mdx
+++ b/docs/integrations/platforms/docker.mdx
@@ -2,7 +2,9 @@
title: "Docker"
---
-## Step 1: Add CLI to your Dockerfile
+Infisical can be used in a Dockerfile to inject environment variables into a Docker container.
+
+## Add the CLI to your Dockerfile
@@ -29,14 +31,10 @@ title: "Docker"
-## Step 2: Generate Infisical Token
-
-[Generate an Infisical Token](../../getting-started/dashboard/token) and keep it handy.
-
-## Step 3: Set start command of your container
+## Modify the start command in your Dockerfile
```dockerfile
-CMD ["infisical", "--env=[your-project-env-name]", "projectId=[your-project-id]", "run", "---", ""]
+CMD ["infisical", "--env=[env]", "projectId=[projectId]", "run", "---", "[your application start command]"]
# example
CMD ["infisical", "--env=prod", "projectId=62faf98ae0b05e83239b5da41", "run", "---", "npm run start"]
@@ -49,12 +47,14 @@ Required options:
| `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` |
| `--projectId` | Used to link a local project to the platform | `None` |
-## Step 4: Feed Docker your Infisical Token
+## Generate an Infisical Token
-The CLI looks out for an environment variable called the `INFISICAL_TOKEN` which you can set depending on where you run the CLI. If `INFISICAL_TOKEN` is detected by the CLI, it will authenticate and retrieve the environment variables which the token is authorized for.
+[Generate an Infisical Token](../../getting-started/dashboard/token) and keep it handy.
+
+## Feed Docker your Infisical Token
+
+The CLI looks out for an environment variable called `INFISICAL_TOKEN`. If the token is detected, the CLI will authenticate, retrieve, and inject the environment variables which the token is authorized for.
```bash
- docker run --env INFISICAL_TOKEN=[the-token-you-got-from-step-2]...
+ docker run --env INFISICAL_TOKEN=[token]...
```
-
-Note: `INFISICAL_TOKEN` is the token you generated in step 2.
diff --git a/docs/mint.json b/docs/mint.json
index baea4bbe3..1d5246680 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -27,90 +27,147 @@
"url": "https://app.infisical.com/signup"
},
"anchors": [
+ {
+ "name": "Security",
+ "icon": "shield-halved",
+ "url": "security"
+ },
+ {
+ "name": "Self-hosting",
+ "icon": "server",
+ "url": "self-hosting"
+ },
+ {
+ "name": "Integrations",
+ "icon": "plug",
+ "url": "integrations"
+ },
+ {
+ "name": "Contributing",
+ "icon": "code",
+ "url": "contributing"
+ },
{
"name": "Blog",
"icon": "newspaper",
"url": "https://blog.infisical.com/"
+ },
+ {
+ "name": "Slack",
+ "icon": "slack",
+ "url": "https://join.slack.com/t/infisical-users/shared_invite/zt-1kovn1q6p-p5fvJo7o083naouDkOzgZQ"
+ },
+ {
+ "name": "GitHub",
+ "icon": "github",
+ "url": "https://github.com/Infisical/infisical"
}
],
"navigation": [
{
- "group": " ",
+ "group": "Overview",
"pages": [
+ "getting-started/introduction",
+ "getting-started/quickstart",
+ "getting-started/features"
+ ]
+ },
+ {
+ "group": "Platform",
+ "pages": [
+ "getting-started/dashboard/organization",
+ "getting-started/dashboard/project",
+ "getting-started/dashboard/integrations",
+ "getting-started/dashboard/token"
+ ]
+ },
+ {
+ "group": "CLI",
+ "pages": [
+ "cli/overview",
+ "cli/usage",
{
- "group": "Overview",
+ "group": "Reference",
"pages": [
- "getting-started/introduction",
- "getting-started/quickstart",
- "getting-started/features"
- ]
- },
- {
- "group": "Security",
- "pages": [
- "security/overview",
- "security/data-model",
- "security/mechanics"
- ]
- },
- {
- "group": "Web UI",
- "pages": [
- "getting-started/dashboard/create-account",
- "getting-started/dashboard/organization",
- "getting-started/dashboard/project",
- "getting-started/dashboard/integrations",
- "getting-started/dashboard/token"
- ]
- },
- {
- "group": "CLI",
- "pages": [
- "cli/overview",
- "cli/usage",
- {
- "group": "Reference",
- "pages": [
- "cli/reference/commands",
- "cli/reference/login",
- "cli/reference/init",
- "cli/reference/run"
- ]
- }
- ]
- },
- {
- "group": "Integrations",
- "pages": [
- "integrations/overview",
- "integrations/heroku",
- "integrations/docker",
- "integrations/docker-compose"
- ]
- },
- {
- "group": "Self-hosting",
- "pages": [
- "self-hosting/overview",
- {
- "group": "Deployments",
- "pages": ["self-hosting/deployments/linux"]
- },
- {
- "group": "Configuration",
- "pages": ["self-hosting/configuration/envars"]
- }
- ]
- },
- {
- "group": "Contributing",
- "pages": [
- "contributing/overview",
- "contributing/code-of-conduct",
- "contributing/developing"
+ "cli/reference/commands",
+ "cli/reference/login",
+ "cli/reference/init",
+ "cli/reference/run"
]
}
]
+ },
+ {
+ "group": "Self-hosting",
+ "pages": [
+ "self-hosting/overview",
+ {
+ "group": "Deployments options",
+ "pages": [
+ "self-hosting/deployments/linux",
+ "self-hosting/deployments/kubernetes"
+ ]
+ },
+ {
+ "group": "Configuration",
+ "pages": ["self-hosting/configuration/envars"]
+ }
+ ]
+ },
+ {
+ "group": "Integrations",
+ "pages": [
+ "integrations/overview"
+ ]
+ },
+ {
+ "group": "Platforms",
+ "pages": [
+ "integrations/platforms/docker",
+ "integrations/platforms/docker-compose"
+ ]
+ },
+ {
+ "group": "Cloud",
+ "pages": [
+ "integrations/cloud/heroku"
+ ]
+ },
+ {
+ "group": "Frameworks",
+ "pages": [
+ "integrations/frameworks/react",
+ "integrations/frameworks/vue",
+ "integrations/frameworks/express",
+ "integrations/frameworks/nextjs",
+ "integrations/frameworks/nestjs",
+ "integrations/frameworks/nuxt",
+ "integrations/frameworks/gatsby",
+ "integrations/frameworks/remix",
+ "integrations/frameworks/vite",
+ "integrations/frameworks/fiber",
+ "integrations/frameworks/django",
+ "integrations/frameworks/flask",
+ "integrations/frameworks/laravel",
+ "integrations/frameworks/rails"
+ ]
+ },
+ {
+ "group": "Security",
+ "pages": [
+ "security/overview",
+ "security/data-model",
+ "security/mechanics"
+ ]
+ },
+ {
+ "group": "Contributing",
+ "pages": [
+ "contributing/overview",
+ "contributing/code-of-conduct",
+ "contributing/developing",
+ "contributing/FAQ"
+ ]
}
],
"backgroundImage": "/images/background.png"
diff --git a/docs/self-hosting/deployments/kubernetes.mdx b/docs/self-hosting/deployments/kubernetes.mdx
new file mode 100644
index 000000000..8ed2c0e05
--- /dev/null
+++ b/docs/self-hosting/deployments/kubernetes.mdx
@@ -0,0 +1,54 @@
+---
+title: "Kubernetes"
+description: "Deploy with Kubernetes"
+---
+
+
+Self-host vs. Infisical Cloud
+
+Self-hosting Infisical means managing the service yourself, taking care of upgrades, scaling, security, etc.
+
+If you're less technical and looking for a hands-free experience with minimal overhead then we recommend Infisical Cloud.
+
+
+
+**Prerequisites**
+- You have understanding of [Kubernetes](https://kubernetes.io/)
+- You have understanding of [Helm package manager](https://helm.sh/)
+- You have [kubectl](https://kubernetes.io/docs/reference/kubectl/kubectl/) installed and connected to your kubernetes cluster
+
+
+#### 1. Fill our environment variables
+
+Before you can deploy the Helm chart, you must fill out the required environment variables. To do so, please either download or copy the
+contents of [this file](https://raw.githubusercontent.com/Infisical/infisical/main/helm-charts/infisical/values.yaml) to a `.yaml` file.
+_Refer to the available [environment variables](../../self-hosting/configuration/envars)_
+
+Once you have a local copy of the values file, fill our the required environment variables and save the file.
+
+
+#### 2. Install Infisical Helm repository
+
+```bash
+helm repo add infisical-helm-charts 'https://dl.cloudsmith.io/public/infisical/helm-charts/helm/charts/'
+
+helm repo update
+```
+
+#### 3. Install the Helm chart
+
+By default, the helm chart will be installed on your default namespace. If you wish to install the Chart on a different namespace, you may specify
+that by adding the `--namespace ` to your `helm install` command.
+
+```bash
+## Installs to default namespace
+helm install infisical-helm-charts/infisical --values
+```
+
+
+If you have not filled out all of the required environment variables, you will see an error message prompting you to
+do so.
+
+
+4. Your Infisical installation is complete and should be running on the host name you specified in Ingress in `values.yaml`.
+Note: Please allow an additional time (2 minutes) for the frontend pods to be fully ready.
\ No newline at end of file
diff --git a/docs/self-hosting/deployments/linux.mdx b/docs/self-hosting/deployments/linux.mdx
index e3392e6c3..0282e46de 100644
--- a/docs/self-hosting/deployments/linux.mdx
+++ b/docs/self-hosting/deployments/linux.mdx
@@ -51,4 +51,4 @@ nano .env
docker-compose -f docker-compose.yml up -d
```
-5. Your Infisical installation is complete and should be running on port 8080. Please note that the containers are not exposed to the internet and only bind to the localhost. It's up to you to configure a firewall, SSL certificates, and implement any additional security measures.
+5. Your Infisical installation is complete and should be running on [http://localhost:8080](http://localhost:8080). Please note that the containers are not exposed to the internet and only bind to the localhost. It's up to you to configure a firewall, SSL certificates, and implement any additional security measures.
diff --git a/docs/self-hosting/overview.mdx b/docs/self-hosting/overview.mdx
index 8f2df5c37..b0729637c 100644
--- a/docs/self-hosting/overview.mdx
+++ b/docs/self-hosting/overview.mdx
@@ -9,17 +9,22 @@ Self-hosting Infisical means managing the service yourself, taking care of upgra
If you're less technical and looking for a hands-free experience with minimal overhead then we recommend Infisical Cloud.
-Infisical Cloud also comes with some extra features unavailabe in the self-hosted edition. You can find more information about Infisical Cloud's offering on the pricing page.
+Infisical Cloud also comes with some extra features unavailable in the self-hosted edition. You can find more information about Infisical Cloud's offering on the pricing page.
## Deployment options
-Infisical can be deployed on a Linux VM with docker-compose. We're rolling out more specific deployment options for DigitalOcean, AWS, GCP, and Azure soon.
+Infisical can be deployed on a Linux VM with docker-compose and Kubernetes. We're rolling out more specific deployment options for DigitalOcean, AWS, GCP, and Azure soon.
-Options:
-
-- [Linux VM](/self-hosting/deployments/linux)
+
+
+ Deploy to any Linux with Docker
+
+
+ Deploy to your Kubernetes cluster
+
+
## Telemetry
diff --git a/frontend/.eslintrc.json b/frontend/.eslintrc
similarity index 65%
rename from frontend/.eslintrc.json
rename to frontend/.eslintrc
index 0c5504b90..b562aaa1f 100644
--- a/frontend/.eslintrc.json
+++ b/frontend/.eslintrc
@@ -1,10 +1,21 @@
{
- "extends": "next/core-web-vitals",
- "plugins": [
- "simple-import-sort"
+ "extends": [
+ "eslint:recommended",
+ "plugin:@typescript-eslint/recommended",
+ "next",
+ "next/core-web-vitals"
],
+ "parser": "@typescript-eslint/parser",
+ "plugins": ["simple-import-sort", "@typescript-eslint"],
"rules": {
"react-hooks/exhaustive-deps": "off",
+ "no-unused-vars": "off",
+ "@typescript-eslint/no-unused-vars": "off",
+ "@typescript-eslint/no-var-requires": "off",
+ "@typescript-eslint/no-empty-function": "off",
+ "@typescript-eslint/no-explicit-any": "off",
+ "@typescript-eslint/no-non-null-assertion": "off",
+
"simple-import-sort/exports": "warn",
"simple-import-sort/imports": [
"warn",
@@ -18,15 +29,9 @@
"^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)"
],
// Packages `react` related packages
- [
- "^react",
- "^next",
- "^@?\\w"
- ],
+ ["^react", "^next", "^@?\\w"],
// Internal packages.
- [
- "^~(/.*|$)"
- ],
+ ["^~(/.*|$)"],
// Relative imports
[
"^\\.\\.(?!/?$)",
@@ -36,11 +41,9 @@
"^\\./?$"
],
// Style imports.
- [
- "^.+\\.?(css|scss)$"
- ]
+ ["^.+\\.?(css|scss)$"]
]
}
]
}
-}
\ No newline at end of file
+}
diff --git a/frontend/README.md b/frontend/README.md
index b33ff4335..d97bb4bef 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -1,20 +1,22 @@
This is the client repository for Infisical.
-## Before you get started with development locally
+## Before you get started with development locally
+
Please ensure you have Docker and Docker Compose installed for your OS.
-### Steps to start server
+### Steps to start server
+
- `CD` into the repo
- run command `docker-compose -f docker-compose.dev.yml up --build --force-recreate`
-- Vist localhost:3000 and the website should be live
+- Visit localhost:3000 and the website should be live
+
+### Steps to shutdown this Docker compose
-### Steps to shutdown this Docker compose
- `CD` into this repo
-- run command `docker-compose -f docker-compose-dev.yml down`
+- run command `docker-compose -f docker-compose.dev.yml down`
### Notes
-Any changes made to local files in the `/components`, `/pages`, `styles` will be hot reloaded. If would like like to watch for other files or folders live, please add them to the docker volume.
+
+Any changes made to local files in the `/components`, `/pages`, `/styles` will be hot reloaded. If would like like to watch for other files or folders live, please add them to the docker volume.
You will also need to ensure that a .env.local file exists with all required environment variables
-
-
diff --git a/frontend/components/basic/Error.js b/frontend/components/basic/Error.tsx
similarity index 84%
rename from frontend/components/basic/Error.js
rename to frontend/components/basic/Error.tsx
index 78a181016..79cc6e5f1 100644
--- a/frontend/components/basic/Error.js
+++ b/frontend/components/basic/Error.tsx
@@ -1,8 +1,8 @@
-import React, { useState } from "react";
+import React from "react";
import { faExclamationTriangle } from "@fortawesome/free-solid-svg-icons";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
-export default function Error({ text }) {
+export default function Error({ text }: { text: string }): JSX.Element {
return (
void,
+ data: string[],
+ text: string,
+ buttonAction: () => void,
+ width: string,
+}
+
/**
* This is the component that we use for drop down lists.
- * @param {*} param0
+ * @param {object} obj
+ * @param {string} obj.selected - the item that is currently selected
+ * @param {function} obj.onChange - what happends if you select the item inside a list
+ * @param {string[]} obj.data - all the options available
+ * @param {string} obj.text - the text that shows us in front of the select option
+ * @param {function} obj.buttonAction - if there is a button at the bottom of the list, this is the action that happens when you click the button
+ * @param {string} obj.width - button width
* @returns
*/
export default function ListBox({
@@ -21,10 +36,7 @@ export default function ListBox({
text,
buttonAction,
width,
- workspaceMapping = [],
-}) {
- const router = useRouter();
-
+} : ListBoxProps): JSX.Element {
return (
@@ -61,7 +73,7 @@ export default function ListBox({
`my-0.5 relative cursor-default select-none py-2 pl-10 pr-4 rounded-md ${
selected ? "bg-white/10 text-gray-400 font-bold" : ""
} ${
- active & !selected
+ active && !selected
? "bg-white/5 text-mineshaft-200 cursor-pointer"
: "text-gray-400"
} `
diff --git a/frontend/components/basic/buttons/Button.tsx b/frontend/components/basic/buttons/Button.tsx
index c0db709c1..5fe2db803 100644
--- a/frontend/components/basic/buttons/Button.tsx
+++ b/frontend/components/basic/buttons/Button.tsx
@@ -1,35 +1,59 @@
import React from "react";
import Image from "next/image";
import { IconProp } from "@fortawesome/fontawesome-svg-core";
-import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
+import {
+ FontAwesomeIcon,
+ FontAwesomeIconProps,
+} from "@fortawesome/react-fontawesome";
-var classNames = require("classnames");
+const classNames = require("classnames");
type ButtonProps = {
text: string;
onButtonPressed: () => void;
- loading: boolean;
+ loading?: boolean;
color: string;
size: string;
- icon: IconProp;
- active: boolean;
- iconDisabled: string;
- textDisabled: string;
-}
+ icon?: IconProp;
+ active?: boolean;
+ iconDisabled?: string;
+ textDisabled?: string;
+};
-export default function Button (props: ButtonProps): JSX.Element {
+/**
+ * This is the main butto component in the app.
+ * @param {object} props
+ * @param {string} props.text - text inside the button
+ * @param {function} props.onButtonPressed - the action that happens when the button is clicked
+ * @param {boolean} props.loading - if a button is currently in the laoding state
+ * @param {string} props.color - button color
+ * @param {string} props.size - button size
+ * @param {FontAwesomeIconProps} props.icon - the icon inside the button
+ * @param {boolean} props.active - if the button is active or disabled
+ * @param {FontAwesomeIconProps} props.text - the icon inside the button when it is disabled
+ * @param {string} props.textDisable - text inside the button when it is disabled
+ * @returns
+ */
+export default function Button(props: ButtonProps): JSX.Element {
// Check if the button show always be 'active' - then true;
// or if it should switch between 'active' and 'disabled' - then give the status
- const activityStatus = props.active || (props.text != "" && props.textDisabled == undefined)
-
- let styleButton = classNames(
+ const activityStatus =
+ props.active || (props.text != "" && props.textDisabled == undefined);
+
+ const styleButton = classNames(
"group m-auto md:m-0 inline-block rounded-md duration-200",
// Setting background colors and hover modes
- props.color == "mineshaft" && activityStatus && "bg-mineshaft-700 hover:bg-primary",
+ props.color == "mineshaft" &&
+ activityStatus &&
+ "bg-mineshaft-700 hover:bg-primary",
props.color == "mineshaft" && !activityStatus && "bg-mineshaft",
- (props.color == "primary" || !props.color) && activityStatus && "bg-primary hover:opacity-80",
- (props.color == "primary" || !props.color) && !activityStatus && "bg-primary",
+ (props.color == "primary" || !props.color) &&
+ activityStatus &&
+ "bg-primary hover:opacity-80",
+ (props.color == "primary" || !props.color) &&
+ !activityStatus &&
+ "bg-primary",
props.color == "red" && "bg-red",
// Changing the opacity when active vs when not
@@ -43,7 +67,7 @@ export default function Button (props: ButtonProps): JSX.Element {
props.size == "icon-sm" && "h-9 w-9 flex items-center justify-center"
);
- let styleMainDiv = classNames(
+ const styleMainDiv = classNames(
"relative font-medium flex items-center",
// Setting the text color for the text and icon
@@ -55,11 +79,11 @@ export default function Button (props: ButtonProps): JSX.Element {
props.size == "icon" && "flex items-center justify-center"
);
- let textStyle = classNames(
+ const textStyle = classNames(
"relative duration-200",
// Show the loading sign if the loading indicator is on
- props.loading == true ? "opacity-0" : "opacity-100",
+ props.loading ? "opacity-0" : "opacity-100",
props.size == "md" && "text-sm",
props.size == "lg" && "text-lg"
);
@@ -86,7 +110,7 @@ export default function Button (props: ButtonProps): JSX.Element {
+
+ 
+
@@ -30,12 +33,12 @@
**[Infisical](https://infisical.com)** is an open source, E2EE tool to help teams manage and sync environment variables across their development workflow and infrastructure. It's designed to be simple and take minutes to get going.
-- **User-Friendly Dashboard** to manage your team's environment variables within projects
+- **[User-Friendly Dashboard](https://infisical.com/docs/getting-started/dashboard/project)** to manage your team's environment variables within projects
- **[Language-Agnostic CLI](https://infisical.com/docs/cli/overview)** that pulls and injects environment variables into your local workflow
- **[Complete control over your data](https://infisical.com/docs/self-hosting/overview)** - host it yourself on any infrastructure
- **Navigate Multiple Environments** per project (e.g. development, staging, production, etc.)
- **Personal/Shared** scoping for environment variables
-- **[Integrations](https://infisical.com/docs/integrations/heroku)** with CI/CD and production infrastructure (Heroku available, more coming soon)
+- **[Integrations](https://infisical.com/docs/integrations/overview)** with CI/CD and production infrastructure (Heroku available, more coming soon)
- π **1-Click Deploy** to Digital Ocean and Heroku
- π **Authentication/Authorization** for projects (read/write controls soon)
- π **Automatic Secret Rotation**
@@ -51,15 +54,13 @@ To quickly get started, visit our [get started guide](https://infisical.com/docs
## What's cool about this?
-Infisical is simple, E2EE, and (soon to be) complete.
+Infisical makes secret management simple and end-to-end encrypted by default. We're on a mission to make it more accessible to all developers, not just security teams.
According to a [report](https://www.ekransystem.com/en/blog/secrets-management) in 2019, only 10% of organizations use secret management solutions despite all using digital secrets to some extent.
-We're on a mission to make secret management more accessible to everyone β that means building for developers, not just security teams.
-
If you care about efficiency and security, then Infisical is right for you.
-Need any integrations or want a new feature? Feel free to [create an issue](https://github.com/Infisical/infisical/issues) or [contribute](https://infisical.com/docs/contributing/overview) directly to the repository.
+We are currently working hard to make Infisical more extensive. Need any integrations or want a new feature? Feel free to [create an issue](https://github.com/Infisical/infisical/issues) or [contribute](https://infisical.com/docs/contributing/overview) directly to the repository.
## Contributing
@@ -69,9 +70,10 @@ Not sure where to get started? [Book a free, non-pressure pairing sessions with
## Community & Support
-- [GitHub Discussions](https://github.com/Infisical/infisical/discussions) for help with building and discussion.
-- [GitHub Issues](https://github.com/Infisical/infisical-cli/issues) for any bugs and errors you encounter using Infisical.
-- [Community Slack](https://join.slack.com/t/infisical-users/shared_invite/zt-1kdbk07ro-RtoyEt_9E~fyzGo_xQYP6g) for hanging out with the community and quick communication with the team.
+- [Slack](https://join.slack.com/t/infisical-users/shared_invite/zt-1kdbk07ro-RtoyEt_9E~fyzGo_xQYP6g) (For live discussion with the community and the Infisical team)
+- [GitHub Discussions](https://github.com/Infisical/infisical/discussions) (For help with building and deeper conversations about features)
+- [GitHub Issues](https://github.com/Infisical/infisical-cli/issues) (For any bugs and errors you encounter using Infisical)
+- [Twitter](https://twitter.com/infisical) (Get news fast)
## Status
@@ -89,23 +91,179 @@ Infisical officially launched as v.1.0 on November 21st, 2022. However, a lot of
## Integrations
-We're currently setting the foundation and building integrations so secrets can be synced everywhere. Any help is welcome! :)
+We're currently setting the foundation and building [integrations](https://infisical.com/docs/integrations/overview) so secrets can be synced everywhere. Any help is welcome! :)
+
+
