Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vmatsiiako authored Nov 18, 2022
1 parent bea0ff6 commit 9b017c1
Showing 1 changed file with 73 additions and 33 deletions.
106 changes: 73 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,80 @@
<h1 align="center">
<img width="300" src="/img/logoname-black.svg#gh-light-mode-only" alt="ifnisical">
<img width="300" src="/img/logoname-white.svg#gh-dark-mode-only" alt="infisical">
</h1>
<p align="center">
<h1 align="center">Infisical</h1>
<p align="center">Simple, open-source, E2EE platform to sync environment variables</p>
<p align="center">Open-source, end-to-end encrypted, 1-line-of-code tool to sync environment variables across you team and infrastructure.</p>
</p>

<img src="./backend/img/dashboard.png" width="100%" alt="Dashboard">

[Infisical](https://infisical.com) is a simple, open source platform to help organizations manage and sync environment variables across their development workflow and infrastructure. It's designed to be simple and end-to-end encrypted.

- **User-Friendly Dashboard** to manage your organization's environment variables within projects.
- **Language-Agnostic** CLI that pulls and injects environment variables into your local workflow.
- **Authentication/Authorization** for projects (read/write controls coming soon).
- **Multiple Environments** per project (e.g. development, staging, production, etc.)
- **Personal/Shared** scoping for environment variables.
- **1-Click Deploy** to Digital Ocean (other providers coming soon).
- **Integrations** with CI/CD and production infrastructure (coming soon).
- **Automatic Secret Rotation** (coming soon).
- **2FA** (coming soon).
- **Access Logs** (coming soon).
- **Slack Integration** (coming soon).
<h4 align="center">
<a href="https://infisical.com/signup">Get Started - we host (Infisical Cloud)</a> |
<a href="https://infisical.com/docs/self_host_overview">Get Started - you host</a> |
<a href="https://infisical.com/docs/gettingStarted">Docs</a> |
<a href="https://www.infisical.com">Website</a>
</h4>

<h4 align="center">
<a href="https://github.com/medusajs/medusa/blob/master/LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Medusa is released under the MIT license." />
</a>
<a href="https://github.com/infisical/infisical/blob/main/CONTRIBUTING.md">
<img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs welcome!" />
</a>
<a href="https://join.slack.com/t/infisical/shared_invite/zt-1dgg63ln8-G7PCNJdCymAT9YF3j1ewVA">
<img src="https://img.shields.io/badge/chat-on%20Slack-blueviolet" alt="Slack community channel" />
</a>
</h4>

<img src="/img/infisical_github_repo.png" width="100%" alt="Dashboard" />

**[Infisical](https://infisical.com)** is an open source tool to help teams manage and sync environment variables across their development workflow and infrastructure. It's designed to be simple and end-to-end encrypted. You can start with just 1 line of code within 10 minutes.

- **User-Friendly Dashboard** to manage your organization's environment variables within projects
- **[Language-Agnostic CLI](https://infisical.com/docs/CLI)** that pulls and injects environment variables into your local workflow
- **[Complete control over your data](https://infisical.com/docs/self_host_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/Heroku)** with CI/CD and production infrastructure (Heroku available, more coming soon)
- **[1-Click Deploy](https://infisical.com/docs/linux)** to Digital Ocean (other providers coming soon)
- 🔜 **Authentication/Authorization** for projects (read/write controls coming soon)
- 🔜 **Automatic Secret Rotation** (coming soon)
- 🔜 **2FA** (coming soon)
- 🔜 **Access Logs** (coming soon)
- 🔜 **Slack Integration & MS Teams** integrations (coming soon)

And more.

## What's cool about this?

XX
Infisical is the first open-source end-to-end encrypted secret manager that takes less than 10 minutes to setup.

Yes. There are other secret managers out there. Some of them are incredibly complicated - they were built for security teams, not developers. The other ones are not end-to-end encrypted, and because of that they can read your secrets. If you care about efficiency and security at the same time - Infisical is right for you.

On top of that, Infisical is one of the few open source solutions. Need any integrations or want a new feature? You can [create an issue for us](https://github.com/Infisical/infisical/issues) or contribute directly! This is the power of open-source. :)

## Documentation
## Contributing

For full documentation, visit [infisical.com/docs](https://infisical.com/docs).

To see how to contribute, visit [Getting Started](./DEVELOPERS.md).
Whether it's big or small, we ❤️ contributions. Check out our guide to see how to [get started](./DEVELOPERS.md).

Not sure where to get started? [Book a free, non-pressure pairing sessions with one of our teammates](mailto:[email protected]?subject=Pairing%20session&body=I'd%20like%20to%20do%20a%20pairing%20session!)!

## 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/shared_invite/zt-1dgg63ln8-G7PCNJdCymAT9YF3j1ewVA) for hanging out with the community and quick communication with the team.

## Status

- [x] Public Alpha: Anyone can sign up over at [infisical.com](https://infisical.com) but go easy on us, there are kinks and we're just getting started.
- [ ] Public Beta: Stable enough for most non-enterprise use-cases.
- [ ] Public: Production-ready.

## Integrations

We're currently setting the foundation and building integrations so secrets can be synced everywhere.
We're currently setting the foundation and building integrations so secrets can be synced everywhere. Any help is welcome! :)

- [x] Docker
- [x] Docker Compose
Expand All @@ -47,17 +88,6 @@ We're currently setting the foundation and building integrations so secrets can
- [ ] GitLab
- [ ] CircleCI

## Community & Support

- [Community Forum]() for help with building and discussion.
- [GitHub Issues](https://github.com/Infisical/infisical-cli/issues) for any bugs and errors you encounter using Infisical.
- [Slack](https://infisical.slack.com/ssb/redirect) for hanging out with the community and quick communication with the team.

## Status

- [x] Public Alpha: Anyone can sign up over at [infisical.com](https://infisical.com) but go easy on us, there are kinks and we're just getting started.
- [ ] Public Beta: Stable enough for most non-enterprise use-cases.
- [ ] Public: Production-ready.

We're currently in Public Alpha.

Expand All @@ -67,4 +97,14 @@ This repo is entirely MIT licensed, with the exception of the `ee` directory whi

## Security

Looking to report a security vulnerability? Please refer to our [SECURITY.md](./SECURITY.md) file.
Looking to report a security vulnerability? Please don't post about it in GitHub issue. Instead, refer to our [SECURITY.md](./SECURITY.md) file.


## Contributors 🦸

[//]: contributor-faces

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<a href="https://github.com/dangtony98"><img src="https://avatars.githubusercontent.com/u/25857006?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/vlad-matsiiako"><img src="https://avatars.githubusercontent.com/u/78047717?s=96&v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/maidul98"><img src="https://avatars.githubusercontent.com/u/9300960?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/hanywang2"><img src="https://avatars.githubusercontent.com/u/44352119?v=4" width="50" height="50" alt=""/></a>

0 comments on commit 9b017c1

Please sign in to comment.