From 7b11976a60924354702b22a103ecc62d8cb99f22 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Sat, 29 Apr 2023 18:55:27 +0300 Subject: [PATCH 1/5] Preliminary README change proposal --- README.md | 362 ++++++++++-------------------------------------------- 1 file changed, 67 insertions(+), 295 deletions(-) diff --git a/README.md b/README.md index b8c242672..2ed1a08d6 100644 --- a/README.md +++ b/README.md @@ -48,313 +48,74 @@ [Italian language](i18n/README.it.md) [Hindi language](i18n/README.hi.md) +## Table of Contents + +1. [Introduction](#introduction) +2. [Getting started](#getting-started) +3. [Features](#features) +4. [Open-source vs paid](#open-source-vs-paid) +5. [Security](#security) +6. [Contributing](#contributing) +7. [Resources](#resources) +8. [Acknowledgements](#acknowledgements) + +## Introduction + **[Infisical](https://infisical.com)** is an open source, end-to-end encrypted secret manager which you can use to centralize your API keys and configs. From Infisical, you can then distribute these secrets across your whole development lifecycle - from development to production . It's designed to be simple and take minutes to get going. -- **[User-Friendly Dashboard](https://infisical.com/docs/getting-started/dashboard/project)** to manage your team's secrets and configs within projects -- **[Language-Agnostic CLI](https://infisical.com/docs/cli/overview)** that pulls and injects esecrets and configs 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 overrides** for secrets and configs -- **[Integrations](https://infisical.com/docs/integrations/overview)** with CI/CD and production infrastructure -- **[Infisical API](https://infisical.com/docs/api-reference/overview/introduction)** - manage secrets via HTTPS requests to the platform -- **[Secret Versioning](https://infisical.com/docs/getting-started/dashboard/versioning)** to view the change history for any secret -- **[Audit Logs](https://infisical.com/docs/getting-started/dashboard/audit-logs)** to record every action taken in a project -- **[Point-in-time Secrets Recovery](https://infisical.com/docs/getting-started/dashboard/pit-recovery)** for rolling back to any snapshot of your secrets -- **Role-based Access Controls** per environment -- **2FA** (more options coming soon) -- **Smart Security Alerts** -- [**1-Click Deploy** to AWS and Digital Ocean](https://infisical.com/docs/self-hosting/overview) -- 🔜 **Automatic Secret Rotation** -- 🔜 **Slack & MS Teams** integrations +## Getting started -And more. +| Check out the [Quickstarts](https://goteleport.com/docs/installation/) Guide -## 🚀 Get started +### Use Infisical Cloud + +The fastest and most reliable way to get started with Infisical is signing up for free to [Infisical Cloud](https://app.infisical.com/login). + +### Deploy Infisical to production + +Deployment options: [AWS EC2](https://infisical.com/docs/self-hosting/overview), [Kubernetes](https://infisical.com/docs/self-hosting/overview), and [more](https://infisical.com/docs/self-hosting/overview). + +### Run Infisical locally + +To set up and run Infisical locally using Docker Compose, please execute the command provided below: + +```console +git clone https://github.com/Infisical/infisical && cd "$(basename $_ .git)" && cp .env.example .env && docker-compose -f docker-compose.dev.yml up --build +``` To quickly get started, visit our [get started guide](https://infisical.com/docs/getting-started/introduction). -

- - -

+## Features -## 🔥 What's cool about this? +- **[User-Friendly Dashboard](https://infisical.com/docs/getting-started/dashboard/project)** to manage secrets across projects and environments (e.g. development, production, etc.) +- **[Client SDKs](https://infisical.com/docs/sdks/overview)** to fetch secrets for your apps and infrastructure on demand. +- **[Infisical CLI](https://infisical.com/docs/cli/overview)** to fetch and inject secrets into any framework in local development. +- **[Native Integrations](https://infisical.com/docs/integrations/overview)** with platforms like GitHub, Vercel, Netlify, and more. +- **[Complete control over your data](https://infisical.com/docs/self-hosting/overview)** - host it yourself on any infrastructure +- **Personal overrides** for secrets and configs +- **[Secret Versioning](https://infisical.com/docs/getting-started/dashboard/versioning)** and **[Point-in-Time Recovery]()** to version every secret and project state. +- **[Audit Logs](https://infisical.com/docs/getting-started/dashboard/audit-logs)** to record every action taken in a project +- **Role-based Access Controls** per environment +- [**1-Click Deploy** to AWS and Digital Ocean](https://infisical.com/docs/self-hosting/overview) +- [**2FA**](https://infisical.com/docs/getting-started/dashboard/mfa) with more options coming soon. -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. +And much more. -According to a [report](https://www.ekransystem.com/en/blog/secrets-management), only 10% of organizations use secret management solutions despite all using digital secrets to some extent. +## Open-source vs. paid -If you care about efficiency and security, then Infisical is right for you. +This repo available under the [MIT expat license](https://github.com/Infisical/infisical/blob/main/LICENSE), with the exception of the `ee` directory which will contain premium enterprise features requiring a Infisical license in the future. -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. +## Security -## 🔌 Integrations +⚠️ Please do not file GitHub issues or post on our public forum for security vulnerabilities, as they are public! ⚠️ -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! :) +Infisical takes security issues very seriously. If you have any concerns about Infisical or believe you have uncovered a vulnerability, please get in touch via the e-mail address security@infisical.com. In the message, try to provide a description of the issue and ideally a way of reproducing it. The security team will get back to you as soon as possible. - - - - - - - - - -
Platforms Frameworks
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - ✔️ Docker - - - - ✔️ Docker Compose - - - - ✔️ Heroku - -
- - ✔️ Vercel - - - - ✔️ Kubernetes - - - - ✔️ Fly.io - -
- - ✔️ Supabase - - - - ✔️ GitHub Actions - - - - ✔️ Railway - -
- 🔜 GCP SM (https://github.com/Infisical/infisical/issues/285) - - - ✔️ GitLab CI/CD - - - - ✔️ CircleCI - -
- 🔜 Jenkins - - 🔜 Digital Ocean - - - ✔️ Azure Key Vault - -
- - ✔️ Travis CI - - - - ✔️ AWS Secrets Manager - - - 🔜 Forge -
- 🔜 Bitbucket - - - ✔️ AWS Parameter Store - - - - ✔️ Render - -
- 🔜 BuddyCI - - 🔜 Serverless - - - ✔️ Netlify - -
- - 		- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - ✔️ React - - - - ✔️ Express - -
- - ✔️ Gatsby - - - - ✔️ Flask - -
- - ✔️ Django - - - - ✔️ Laravel - -
- - ✔️ NestJS - - - - ✔️ Remix - -
- - ✔️ Next.js - - - - ✔️ Vite - -
- - ✔️ Vue - - - - ✔️ Ruby on Rails - -
- - ✔️ Fiber - - - - ✔️ Nuxt - -
- - ✔️ .NET - - - And more... -
- -
- -## 💚 Community & Support - -- [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) - -## 🏘 Open-source vs. paid - -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 +Note that this security address should be used only for undisclosed vulnerabilities. Please report any security problems to us before disclosing it publicly. Looking to report a security vulnerability? Please don't post about it in GitHub issue. Instead, refer to our [SECURITY.md](./SECURITY.md) file. -## 🚨 Stay Up-to-Date - -Infisical officially launched as v.1.0 on November 21st, 2022. There are a lot of new features coming very frequently. Watch **releases** of this repository to be notified about future updates: - -![infisical-star-github](https://github.com/Infisical/infisical/blob/main/.github/images/star-infisical.gif?raw=true) - -## 🌱 Contributing +## Contributing Whether it's big or small, we love contributions ❤️ Check out our guide to see how to [get started](https://infisical.com/docs/contributing/overview). @@ -363,7 +124,23 @@ Not sure where to get started? You can: - [Book a free, non-pressure pairing sessions with one of our teammates](mailto:tony@infisical.com?subject=Pairing%20session&body=I'd%20like%20to%20do%20a%20pairing%20session!)! - Join our Slack, and ask us any questions there. -## 🦸 Contributors +## Translations + +Infisical is currently available in English, Korean, French, and Portuguese (Brazil). Help us translate Infisical to your language! + +You can find all the info in [this issue](https://github.com/Infisical/infisical/issues/181). + +## Resources + +- [Slack](https://join.slack.com/t/infisical-users/shared_invite/zt-1kdbk07ro-RtoyEt_9E~fyzGo_xQYP6g) +- [GitHub](https://github.com/Infisical/infisical) for code, issues, and pull requests +- [Twitter](https://twitter.com/infisical) for fast news +- [YouTube](https://www.youtube.com/@infisical5306) for videos on secret management +- [Blog](https://infisical.com/blog) for secret management insights, articles, tutorials, and updates +- Docs for Infisical features +- [Roadmap](https://www.notion.so/infisical/be2d2585a6694e40889b03aef96ea36b?v=5b19a8127d1a4060b54769567a8785fa) for planned features + +## Acknowledgements [//]: contributor-faces @@ -373,8 +150,3 @@ Not sure where to get started? You can: -## 🌎 Translations - -Infisical is currently available in English, Korean, French, and Portuguese (Brazil). Help us translate Infisical to your language! - -You can find all the info in [this issue](https://github.com/Infisical/infisical/issues/181). From 2b605856a3b2d05715bbbde3fa147dde99716e7d Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Sat, 29 Apr 2023 20:55:52 +0300 Subject: [PATCH 2/5] Update README --- README.md | 52 ++++++++++++++++++++++++---------------------------- 1 file changed, 24 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 2ed1a08d6..3a301f7a0 100644 --- a/README.md +++ b/README.md @@ -48,21 +48,26 @@ [Italian language](i18n/README.it.md) [Hindi language](i18n/README.hi.md) -## Table of Contents - -1. [Introduction](#introduction) -2. [Getting started](#getting-started) -3. [Features](#features) -4. [Open-source vs paid](#open-source-vs-paid) -5. [Security](#security) -6. [Contributing](#contributing) -7. [Resources](#resources) -8. [Acknowledgements](#acknowledgements) - ## Introduction **[Infisical](https://infisical.com)** is an open source, end-to-end encrypted secret manager which you can use to centralize your API keys and configs. From Infisical, you can then distribute these secrets across your whole development lifecycle - from development to production . It's designed to be simple and take minutes to get going. +## Features + +- **[User-friendly dashboard](https://infisical.com/docs/getting-started/dashboard/project)** to manage secrets across projects and environments (e.g. development, production, etc.) +- **[Client SDKs](https://infisical.com/docs/sdks/overview)** to fetch secrets for your apps and infrastructure on demand +- **[Infisical CLI](https://infisical.com/docs/cli/overview)** to fetch and inject secrets into any framework in local development +- **[Native integrations](https://infisical.com/docs/integrations/overview)** with platforms like GitHub, Vercel, Netlify, and more +- [**Automatic Kubernetes deployment secret reloads**]() +- **[Complete control over your data](https://infisical.com/docs/self-hosting/overview)** - host it yourself on any infrastructure +- **[Secret versioning](https://infisical.com/docs/getting-started/dashboard/versioning)** and **[Point-in-Time Recovery]()** to version every secret and project state +- **[Audit logs](https://infisical.com/docs/getting-started/dashboard/audit-logs)** to record every action taken in a project +- **Role-based Access Controls** per environment +- [**Simple on-premise deployments** to AWS and Digital Ocean](https://infisical.com/docs/self-hosting/overview) +- [**2FA**](https://infisical.com/docs/getting-started/dashboard/mfa) with more options coming soon + +And much more. + ## Getting started | Check out the [Quickstarts](https://goteleport.com/docs/installation/) Guide @@ -71,35 +76,26 @@ The fastest and most reliable way to get started with Infisical is signing up for free to [Infisical Cloud](https://app.infisical.com/login). -### Deploy Infisical to production +### Deploy Infisical on premise Deployment options: [AWS EC2](https://infisical.com/docs/self-hosting/overview), [Kubernetes](https://infisical.com/docs/self-hosting/overview), and [more](https://infisical.com/docs/self-hosting/overview). ### Run Infisical locally -To set up and run Infisical locally using Docker Compose, please execute the command provided below: +To set up and run Infisical locally, make sure you have Git and Docker installed on your system. Then run the command for your system: + +Linux/macOS: ```console git clone https://github.com/Infisical/infisical && cd "$(basename $_ .git)" && cp .env.example .env && docker-compose -f docker-compose.dev.yml up --build ``` -To quickly get started, visit our [get started guide](https://infisical.com/docs/getting-started/introduction). +Windows Command Prompt: -## Features +```console +git clone https://github.com/Infisical/infisical && cd infisical && copy .env.example .env && docker-compose -f docker-compose.dev.yml up --build +``` -- **[User-Friendly Dashboard](https://infisical.com/docs/getting-started/dashboard/project)** to manage secrets across projects and environments (e.g. development, production, etc.) -- **[Client SDKs](https://infisical.com/docs/sdks/overview)** to fetch secrets for your apps and infrastructure on demand. -- **[Infisical CLI](https://infisical.com/docs/cli/overview)** to fetch and inject secrets into any framework in local development. -- **[Native Integrations](https://infisical.com/docs/integrations/overview)** with platforms like GitHub, Vercel, Netlify, and more. -- **[Complete control over your data](https://infisical.com/docs/self-hosting/overview)** - host it yourself on any infrastructure -- **Personal overrides** for secrets and configs -- **[Secret Versioning](https://infisical.com/docs/getting-started/dashboard/versioning)** and **[Point-in-Time Recovery]()** to version every secret and project state. -- **[Audit Logs](https://infisical.com/docs/getting-started/dashboard/audit-logs)** to record every action taken in a project -- **Role-based Access Controls** per environment -- [**1-Click Deploy** to AWS and Digital Ocean](https://infisical.com/docs/self-hosting/overview) -- [**2FA**](https://infisical.com/docs/getting-started/dashboard/mfa) with more options coming soon. - -And much more. ## Open-source vs. paid From fc2846534f398bf13e6a574ca174fbb82dda6f79 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Sat, 29 Apr 2023 21:06:25 +0300 Subject: [PATCH 3/5] Update README --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3a301f7a0..78e473d43 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ infisical

-

Open-source, end-to-end encrypted tool to manage secrets and configs across your team, devices, and infrastructure.

+

Open-source, end-to-end encrypted platform to manage secrets and configs across your team and infrastructure.

@@ -70,7 +70,7 @@ And much more. ## Getting started -| Check out the [Quickstarts](https://goteleport.com/docs/installation/) Guide +| Check out the [Quickstarts](https://infisical.com/docs/getting-started/introduction) Guide ### Use Infisical Cloud @@ -103,7 +103,7 @@ This repo available under the [MIT expat license](https://github.com/Infisical/i ## Security -⚠️ Please do not file GitHub issues or post on our public forum for security vulnerabilities, as they are public! ⚠️ +⚠️ Please do not file GitHub issues or post on our public forum for security vulnerabilities, as they are public! Infisical takes security issues very seriously. If you have any concerns about Infisical or believe you have uncovered a vulnerability, please get in touch via the e-mail address security@infisical.com. In the message, try to provide a description of the issue and ideally a way of reproducing it. The security team will get back to you as soon as possible. @@ -120,20 +120,14 @@ Not sure where to get started? You can: - [Book a free, non-pressure pairing sessions with one of our teammates](mailto:tony@infisical.com?subject=Pairing%20session&body=I'd%20like%20to%20do%20a%20pairing%20session!)! - Join our Slack, and ask us any questions there. -## Translations - -Infisical is currently available in English, Korean, French, and Portuguese (Brazil). Help us translate Infisical to your language! - -You can find all the info in [this issue](https://github.com/Infisical/infisical/issues/181). - ## Resources -- [Slack](https://join.slack.com/t/infisical-users/shared_invite/zt-1kdbk07ro-RtoyEt_9E~fyzGo_xQYP6g) +- [Docs](https://infisical.com/docs/getting-started/introduction) for comprehensive documentation and guides +- [Slack](https://join.slack.com/t/infisical-users/shared_invite/zt-1kdbk07ro-RtoyEt_9E~fyzGo_xQYP6g) for discussion with the community and Infisical team. - [GitHub](https://github.com/Infisical/infisical) for code, issues, and pull requests - [Twitter](https://twitter.com/infisical) for fast news - [YouTube](https://www.youtube.com/@infisical5306) for videos on secret management - [Blog](https://infisical.com/blog) for secret management insights, articles, tutorials, and updates -- Docs for Infisical features - [Roadmap](https://www.notion.so/infisical/be2d2585a6694e40889b03aef96ea36b?v=5b19a8127d1a4060b54769567a8785fa) for planned features ## Acknowledgements From a85a7d1b009c29effc32019856ec6c5dfe615913 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Sat, 29 Apr 2023 21:23:05 +0300 Subject: [PATCH 4/5] Update README --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 78e473d43..aa1d7d4c9 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,9 @@ ## Introduction -**[Infisical](https://infisical.com)** is an open source, end-to-end encrypted secret manager which you can use to centralize your API keys and configs. From Infisical, you can then distribute these secrets across your whole development lifecycle - from development to production . It's designed to be simple and take minutes to get going. +**[Infisical](https://infisical.com)** is an open source, end-to-end encrypted secret management platform that teams use to centralize their secrets like API keys, database credentials, and configurations. + +We're on a mission to make secret management more accessible to everyone, not just security teams, and that means redesigning the entire developer experience from ground up. ## Features @@ -103,7 +105,7 @@ This repo available under the [MIT expat license](https://github.com/Infisical/i ## Security -⚠️ Please do not file GitHub issues or post on our public forum for security vulnerabilities, as they are public! +Please do not file GitHub issues or post on our public forum for security vulnerabilities, as they are public! Infisical takes security issues very seriously. If you have any concerns about Infisical or believe you have uncovered a vulnerability, please get in touch via the e-mail address security@infisical.com. In the message, try to provide a description of the issue and ideally a way of reproducing it. The security team will get back to you as soon as possible. @@ -113,7 +115,7 @@ Looking to report a security vulnerability? Please don't post about it in GitHub ## Contributing -Whether it's big or small, we love contributions ❤️ Check out our guide to see how to [get started](https://infisical.com/docs/contributing/overview). +Whether it's big or small, we love contributions. Check out our guide to see how to [get started](https://infisical.com/docs/contributing/overview). Not sure where to get started? You can: From 12a1d8e822a1f951bfdc65ff1a287e13e0628ab6 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Sat, 29 Apr 2023 21:41:33 +0300 Subject: [PATCH 5/5] Update README --- README.md | 2 -- SECURITY.md | 10 +++++++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index aa1d7d4c9..a24d18d7f 100644 --- a/README.md +++ b/README.md @@ -111,8 +111,6 @@ Infisical takes security issues very seriously. If you have any concerns about I Note that this security address should be used only for undisclosed vulnerabilities. Please report any security problems to us before disclosing it publicly. -Looking to report a security vulnerability? Please don't post about it in GitHub issue. Instead, refer to our [SECURITY.md](./SECURITY.md) file. - ## Contributing Whether it's big or small, we love contributions. Check out our guide to see how to [get started](https://infisical.com/docs/contributing/overview). diff --git a/SECURITY.md b/SECURITY.md index bc383f109..debde5ba8 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,9 +1,13 @@ # Security Policy -## Supported Versions +## Supported versions We always recommend using the latest version of Infisical to ensure you get all security updates. -## Reporting a Vulnerability +## Reporting vulnerabilities -Please report security vulnerabilities or concerns to team@infisical.com. +Please do not file GitHub issues or post on our public forum for security vulnerabilities, as they are public! + +Infisical takes security issues very seriously. If you have any concerns about Infisical or believe you have uncovered a vulnerability, please get in touch via the e-mail address security@infisical.com. In the message, try to provide a description of the issue and ideally a way of reproducing it. The security team will get back to you as soon as possible. + +Note that this security address should be used only for undisclosed vulnerabilities. Please report any security problems to us before disclosing it publicly. \ No newline at end of file