Maidul Islam
2 years ago
commit
8d00c5cdb7
@ -0,0 +1,9 @@
|
||||
node_modules
|
||||
.env
|
||||
.env.infisical
|
||||
.DS_STORE
|
||||
|
||||
*~
|
||||
*.swn
|
||||
*.swp
|
||||
*.swo
|
||||
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "Infisical CLI"
|
||||
description: "Learn about each supported command and its flags"
|
||||
---
|
||||
|
||||
## Background
|
||||
|
||||
Infisical ships with multiple commands to assist with ongoing project needs; we list these commands and give context for them below.
|
||||
|
||||
<Card title="Install the CLI" icon="lightbulb" href="/installCLI">
|
||||
If you haven't already, install the Infisical CLI
|
||||
</Card>
|
||||
|
||||
Note on arguments:
|
||||
|
||||
- [environment]: the intended environment for the given command being one of dev, staging, or prod.
|
||||
- [projectId]: the project identifier found on the dashboard.
|
||||
|
||||
## Commands
|
||||
|
||||
- `login` used to set the logged in user. Your credentials are saved securely in your system key ring. Note: only one user can be logged in at a time. To change the logged in user, run the command again and overwrite the previous login.
|
||||
- `init` used to link your infisical.com project to your local project. Run this command ideally at the root of your local project. You will have to run this command for each new project you create locally.
|
||||
- `run` used to inject your secrets as environment variables into your application process. Example `infisical run --stage=prod -- npm run start`
|
||||
- `---projectId` flag is used to link your local project to a Infisical.com project. Use this option only when you are injecting via Infisical Token instead of your login.
|
||||
- `---stage` flag is used to set the environment from which your secrets are pulled from. By default, secrets from your project are pulled from the `dev`. To change to for example prod, add `--stage=prod`
|
||||
|
||||
### Global flags
|
||||
These are flags you can add to any command
|
||||
|
||||
- `--domain` you may change this if you are self hosting Infisical. By default, the CLI points to Infisical.com backend. To point to your own backend, make sure to set this flag for each command you run. Example `infisical login --domain=https://mybackend.com`
|
||||
- `--debug` use this flag when you want to see more logs related to the error you are receiving. By default debug logs are hidden. Example `infisical run --debug <your command>`
|
||||
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "Heroku"
|
||||
description: "With this integration, you can automatically sync your secrets to Heroku as soon as you update secrets in Infisical."
|
||||
---
|
||||
|
||||
## Instructions
|
||||
|
||||
### Step 1: Open the integrations csonsole
|
||||
|
||||
Open the Infisical Dashboard. Choose the project in which you want to set up the intergation. Go to the integrations tab in the left sidebar.
|
||||
|
||||
### Step 2: Authenticate with Heroku
|
||||
|
||||
Click on Heroku in the list of available integrations. Log in if asked by Heroku and provide the necessary permissions to Infisical. You will afterwards be redirected back to the integrations page.
|
||||
|
||||
Note: during an integration with Heroku, for security reasons, it is impossible to maintain end-to-end encryption. In theory, this lets Infisical decrypt yor environment variables. In practice, we can assure you that this will never be done, and it allows us to protect your secrets from bad actors online. The core Infisical service will always stay end-to-end encrypted. With any questions, reach out support@infisical.com.
|
||||
|
||||
### Step 3: Start integration
|
||||
|
||||
Once the integration is set up, choose a Heroku App that you want to sync the secrets to, and the Infisical project environment that you would to sync the secrets from. Click on the "Start Integration" button.
|
||||
|
||||
### Step 4: You're good to go!
|
||||
|
||||
The integration should now show status 'In Sync'. Every time you edit the secrets, they will be automatically pushed to Heroku. If you want to update anything in your integration, you will have to delete the current one and create a new one.
|
||||
@ -0,0 +1,135 @@
|
||||
---
|
||||
title: "Code of Conduct"
|
||||
description: ""
|
||||
---
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, caste, color, religion, or sexual
|
||||
identity and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
- Demonstrating empathy and kindness toward other people
|
||||
- Being respectful of differing opinions, viewpoints, and experiences
|
||||
- Giving and gracefully accepting constructive feedback
|
||||
- Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
- Focusing on what is best not just for us as individuals, but for the overall
|
||||
community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
- The use of sexualized language or imagery, and sexual attention or advances of
|
||||
any kind
|
||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or email address,
|
||||
without their explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
[INSERT CONTACT METHOD].
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series of
|
||||
actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or permanent
|
||||
ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within the
|
||||
community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.1, available at
|
||||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
||||
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder][mozilla coc].
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
|
||||
[https://www.contributor-covenant.org/translations][translations].
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||
[mozilla coc]: https://github.com/mozilla/diversity
|
||||
[faq]: https://www.contributor-covenant.org/faq
|
||||
[translations]: https://www.contributor-covenant.org/translations
|
||||
@ -0,0 +1,35 @@
|
||||
---
|
||||
title: "Overview"
|
||||
description: "We welcome any contributions to Infisical, big or small."
|
||||
---
|
||||
|
||||
## Community
|
||||
|
||||
It's the early days of Infisical and we're working hard to build an awesome, inclusive community. In order to grow this, all community members must adhere to our Code of conduct.
|
||||
|
||||
## Bugs and issues
|
||||
|
||||
Bug reports help make Infisical a better experience for everyone. When you report a bug, a template will be created automatically containing information we'd like to know.
|
||||
|
||||
Before raising a new issue, please search existing ones to make sure you're not creating a duplicate.
|
||||
|
||||
<Info>
|
||||
If the issue is related to security, please email us directly at
|
||||
team@infisical.com.
|
||||
</Info>
|
||||
|
||||
## Deciding what to work on
|
||||
|
||||
You can start by browsing through our list of issues or adding your own that improves on the platform experience. Once you've decided on an issue, leave a comment and wait to get approved; this helps avoid multiple people working on the same issue.
|
||||
|
||||
If you're ever in doubt about whether or not a proposed feature aligns with Infisical as a whole, feel free to raise an issue about it and we'll get back to you promptly.
|
||||
|
||||
## Writing and submitting code
|
||||
|
||||
Anyone can contribute code to Infisical. To get started, check out the local development guide, make your changes, and submit a pull request to the main repository.
|
||||
|
||||
## Licensing
|
||||
|
||||
Most of Infisical's code is under the MIT license, though some paid feature restrictions are covered by a proprietary license.
|
||||
|
||||
Any third party components incorporated into our code are licensed under the original license provided by the applicable component owner.
|
||||
@ -0,0 +1,46 @@
|
||||
---
|
||||
title: "Developing"
|
||||
description: "This guide will help you set up and run Infisical in development mode."
|
||||
---
|
||||
|
||||
## Clone the repo
|
||||
|
||||
```bash
|
||||
# change location to the path you want Infisical to be installed
|
||||
cd ~
|
||||
|
||||
# clone the repo and cd to Infisical dir
|
||||
git clone https://github.com/Infisical/infisical
|
||||
cd infisical
|
||||
```
|
||||
|
||||
## Set up environment variables
|
||||
|
||||
Tweak the `.env` according to your preferences. Refer to the available [environment variables](envars).
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
## Docker for development
|
||||
|
||||
```bash
|
||||
# build and start the services
|
||||
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up --build
|
||||
```
|
||||
|
||||
Then browse http://localhost:3000
|
||||
|
||||
```bash
|
||||
# To stop environment use Control+C (on Mac) CTRL+C (on Win) or
|
||||
docker-compose down
|
||||
# start services
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
The docker-compose environment consists of:
|
||||
|
||||
- frontend
|
||||
- backend
|
||||
- mongo
|
||||
- mongo-express
|
||||
|
After Width: | Height: | Size: 1.9 KiB |
@ -0,0 +1,34 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
description: "Infisical is a simple, end-to-end encrypted (E2EE) secrets manager that enables teams to sync and manage their application environment variables."
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
Infisical works by injecting environment variables into your application process. Because of this, Infisical works for all programing languages and platforms.
|
||||
|
||||
Infisical is powered by public-key cryptography to ensure that you are the only person who can access your secrets. Read more about our security [here](https://dub.sh/XocpMvT)
|
||||
<Card
|
||||
title="Security Brief"
|
||||
icon="shield-halved"
|
||||
iconType="duotone"
|
||||
href="https://dub.sh/XocpMvT"
|
||||
>
|
||||
Learn more about our system + security here.
|
||||
</Card>
|
||||
|
||||
|
||||
### Step 1: Make an account
|
||||
|
||||
Head to [https://infisical.com](https://infisical.com/) to make an account and create a project. Once you've made an account, you'll be prompted to a dashboard with some placeholder environment variables. Go ahead and replace the placeholder environment variables with your environment variables from your .env file.
|
||||
|
||||
### Step 2 (Optional): Invite your dev team
|
||||
|
||||
Navigate to the “Team” tab in the left sidebar and invite your teammates to the project by submitting their emails. They'll each receive an email invitation to join the project and get access to the environment variables. A few things to note about invitations due to how our public-key cryptography works:
|
||||
|
||||
- If a teammate is already registered with Infisical, then they'll receive access to the environment variables immediately.
|
||||
- If a teammate is unregistered with Infisical, then they'll have to request access to the environment variables once they've registered.
|
||||
|
||||
### Step 3: Install the CLI
|
||||
The Infisical CLI will allow you to inject secrets into any environment. This includes both your local and production environments.
|
||||
|
||||
|
After Width: | Height: | Size: 112 KiB |
|
After Width: | Height: | Size: 274 KiB |
|
After Width: | Height: | Size: 319 KiB |
@ -0,0 +1,68 @@
|
||||
---
|
||||
title: "Infisical Token"
|
||||
description: "Learn to authenticate via the CLI without in manually"
|
||||
---
|
||||
|
||||
## Background
|
||||
|
||||
To authenticate the Infisical CLI in environments other than your local desktop environment, you will have to utilize the Infisical Token.
|
||||
The Infisical Token is a quick and easy way to authenticate the CLI without having to type in your email and password. This is especially needed
|
||||
in production environments where you cannot type in your login details.
|
||||
|
||||
With the Infisical Token, you can allow read only access to a particular environment (dev, prod, etc.) for a given project for a set amount of time. Once the token expires, any CLI application
|
||||
that relies on it for authentication will be denied access to retrieve the related secrets.
|
||||
|
||||
## Generate a Infisical Token
|
||||
To get started, navigate to your dashboard and select the project for which you would like to generate a Infisical Token for.
|
||||
Then head over to project settings and you should see a similar page like below.
|
||||
|
||||
|
||||
|
||||
To add a new Infisical Token, press the `add new token` button. This will bring up a page like below.
|
||||
|
||||
|
||||
|
||||
Enter a name to help you identify the token then choose the environment from which you would like the CLI to retrieve the secrets from. Lastly, choose a duration
|
||||
for the token.
|
||||
|
||||
<Info>
|
||||
Once the token is expired, the CLI using it will no longer be able to make requests with it.
|
||||
</Info>
|
||||
|
||||
|
||||
## Use Infisical token with CLI
|
||||
Once you have generated a token, it is easy to tell the Infisical CLI to use it.
|
||||
|
||||
### Feeding the token to the CLI
|
||||
The CLI looks out for an environment variable called `INFISICAL_TOKEN`. Setting this environment variable depends on where you run the CLI.
|
||||
For example, if you are running the CLI in a Docker container, you may set the environment variable via the docker run command like so.
|
||||
|
||||
Docker run example:
|
||||
```
|
||||
docker run --env INFISICAL_TOKEN=<the token you generated>...
|
||||
```
|
||||
|
||||
<Warning>
|
||||
In the event your token is exposed, visit the project settings page again and deactivate the token to expire it immediately.
|
||||
</Warning>
|
||||
|
||||
### Prepare `infisical run` command
|
||||
|
||||
Once you have exposed the `INFISICAL_TOKEN` environment variable to the environment the CLI is running in you can prepare the run command.
|
||||
To have the CLI authenticate via the Infisical Token, you must provide values for flags `--stage` and `--projectId`
|
||||
|
||||
Example:
|
||||
```
|
||||
infisical run --stage=prod --projectId=<the project id for the token you generated>
|
||||
```
|
||||
|
||||
<Info>
|
||||
Notice that we do not need to run any other command such as `infisical init` or `infisical login` when we use the Infisical Token.
|
||||
</Info>
|
||||
|
||||
|
||||
To learn more about the commands and it's flags [visit](/CLI)
|
||||
|
||||
### Support
|
||||
|
||||
Lastly, if you have any questions or inquiries, shoot an email over to [support@infisical.com](mailto:support@infisical.com) so we can assist you. Alternatively, feel free to post your question or DM us on Slack here; we'd be happy to connect with you.
|
||||
@ -0,0 +1,124 @@
|
||||
---
|
||||
title: "Install CLI"
|
||||
description: "Install the official Infisical CLI for both your development and production environments"
|
||||
---
|
||||
|
||||
## Install
|
||||
|
||||
Installing Infisical CLI is simple. Just follow the guide for your OS below.
|
||||
|
||||
<Accordion title="Install on MacOS ">
|
||||
Use [brew](https://brew.sh/) package manager
|
||||
|
||||
```
|
||||
$ brew install infisical/get-cli/infisical
|
||||
$ infisical --version
|
||||
```
|
||||
|
||||
To update:
|
||||
|
||||
```
|
||||
$ brew upgrade infisical
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Install on Windows ">
|
||||
Use [Scoop](https://scoop.sh/) package manager
|
||||
|
||||
```
|
||||
$ scoop bucket add org https://github.com/Infisical/scoop-infisical.git
|
||||
$ scoop install infisical
|
||||
$ infisical --version
|
||||
```
|
||||
|
||||
To update:
|
||||
|
||||
```
|
||||
$ scoop update infisical
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
|
||||
<Accordion title="Install on RedHat/CentOS">
|
||||
```
|
||||
$ curl https://raw.githubusercontent.com/Infisical/infisical/main/infisical-cli.repo | tee /etc/yum.repos.d/infisical-cli.repo
|
||||
|
||||
$ yum update && sudo yum install infisical
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Install on Alpine">
|
||||
```
|
||||
$ apk add --no-cache bash sudo curl
|
||||
$ curl -1sLf \
|
||||
'https://dl.cloudsmith.io/public/infisical/infisical-cli/setup.alpine.sh' \
|
||||
| sudo -E bash
|
||||
|
||||
$ sudo apk add infisical
|
||||
|
||||
$ infisical --help
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Install on Debian/Ubuntu">
|
||||
```
|
||||
Add Infisical apt repo
|
||||
$ echo "deb [trusted=yes] https://apt.fury.io/infisical/ /" | tee -a /etc/apt/sources.list.d/infisical.list
|
||||
|
||||
Add prerequisites
|
||||
$ apt update && apt -y curl ca-certificates sudo
|
||||
|
||||
Install infisical cli
|
||||
$ sudo apt update && apt install infisical
|
||||
|
||||
To make sure the CLI has been installed, you may run this command.
|
||||
$ infisical --version
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
## Usage
|
||||
Once you have the CLI installed in your system, follow the guide to login and sync your first project.
|
||||
|
||||
#### Login
|
||||
Login to the CLI by running the following command in your terminal
|
||||
|
||||
```
|
||||
infisical login
|
||||
```
|
||||
<Info>
|
||||
To authenticate without logging in manually, read about [Infisical Token](/infisicalToken)
|
||||
</Info>
|
||||
#### Link secrets to your project
|
||||
After logging in, `CD` into the root of your local project. Then run the following command in the terminal to link your Infisical project to your local project.
|
||||
|
||||
```
|
||||
infisical init
|
||||
```
|
||||
|
||||
#### Inject
|
||||
To inject the secrets from the Infisical project you have selected in step 2 into your application process, run the following command.
|
||||
|
||||
```
|
||||
infisical run -- <your application start command>
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
infisical run -- npm run dev
|
||||
```
|
||||
|
||||
By default, Infisical injects secrets from your development environment. To modify from which environment your secrets are pulled from, use the --stage flag
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
infisical run --stage=prod -- npm run dev
|
||||
```
|
||||
|
||||
You're now automatically pulling and injecting secrets as environment variables into your application!
|
||||
|
||||
### Support
|
||||
We're constantly improving Infisical, so we'd love to get your feedback and take feature requests.
|
||||
|
||||
Lastly, if you have any questions or inquiries, shoot an email over to [support@infisical.com](mailto:support@infisical.com) so we can assist you. Alternatively, feel free to post your question or DM us on Slack here; we'd be happy to connect with you.
|
||||
@ -0,0 +1,55 @@
|
||||
---
|
||||
title: "Linux VM"
|
||||
description: "Deploy with Docker-Compose"
|
||||
---
|
||||
|
||||
<Info>
|
||||
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.
|
||||
|
||||
</Info>
|
||||
|
||||
We provide a docker-compose deployment option for those who want to deploy Infisical onto a Linux VM easily.
|
||||
|
||||
1. Install Docker on your VM
|
||||
|
||||
```bash
|
||||
# Example in ubuntu
|
||||
apt-get update
|
||||
apt-get upgrade
|
||||
apt install docker-compose
|
||||
```
|
||||
|
||||
2. Download the required files
|
||||
|
||||
```bash
|
||||
# Download env file template
|
||||
wget -O .env https://raw.githubusercontent.com/Infisical/infisical-merge/main/.env.example
|
||||
|
||||
# Download docker compose template
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/Infisical/infisical-merge/main/docker-compose.yml
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/Infisical/infisical-merge/main/docker-compose.prod.yml
|
||||
|
||||
# Download nginx config
|
||||
mkdir nginx && cd nginx && wget -O https://raw.githubusercontent.com/Infisical/infisical-merge/main/nginx/default.conf
|
||||
cd ..
|
||||
```
|
||||
|
||||
3. Tweak the `.env` according to your preferences. Refer to the available [environment variables](envars).
|
||||
|
||||
```bash
|
||||
# update environment variables like mongo login
|
||||
nano .env
|
||||
```
|
||||
|
||||
4. Get the service up and running.
|
||||
|
||||
```bash
|
||||
# Start up services in detached mode
|
||||
docker-compose -f docker-compose.yaml -f docker-compose.prod.yml up -d
|
||||
```
|
||||
|
||||
5. Your Infisical installation is complete. Please note that the containers are not exposed to the internet and only bind to the localhost. It's up to you to set up a firewall and implement any additional security measures.
|
||||
|
After Width: | Height: | Size: 6.8 KiB |
|
After Width: | Height: | Size: 6.8 KiB |
@ -0,0 +1,82 @@
|
||||
{
|
||||
"name": "Infisical",
|
||||
"basePath": "/docs",
|
||||
"logo": {
|
||||
"dark": "/docs/logo/dark.svg",
|
||||
"light": "/docs/logo/light.svg",
|
||||
"href": "https://infisical.com"
|
||||
},
|
||||
"favicon": "/favicon.png",
|
||||
"colors": {
|
||||
"primary": "#A1B659",
|
||||
"light": "#E1EB55",
|
||||
"dark": "#A1B659",
|
||||
"ultraLight": "#EFF4DD",
|
||||
"ultraDark": "#8D9F4C",
|
||||
"background": {
|
||||
"dark": "#0D1117"
|
||||
}
|
||||
},
|
||||
"topbarLinks": [{ "name": "Log In", "url": "https://infisical.com/login" }],
|
||||
"topbarCtaButton": {
|
||||
"name": "Start for Free",
|
||||
"url": "https://infisical.com/signup"
|
||||
},
|
||||
"anchors": [
|
||||
{
|
||||
"name": "Security",
|
||||
"icon": "shield-halved",
|
||||
"url": "https://infisical.com/security"
|
||||
},
|
||||
{
|
||||
"name": "Blog",
|
||||
"icon": "newspaper",
|
||||
"url": "https://infisical.com/blog"
|
||||
}
|
||||
],
|
||||
"navigation": [
|
||||
{
|
||||
"group": "Documentation",
|
||||
"pages": [
|
||||
"gettingStarted",
|
||||
"installCLI",
|
||||
"infisicalToken",
|
||||
"CLI"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Integrations",
|
||||
"pages": [
|
||||
"Heroku"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Self-hosting",
|
||||
"pages": [
|
||||
"self_host_overview",
|
||||
{
|
||||
"group": "Deployments",
|
||||
"pages": ["linux"]
|
||||
},
|
||||
{
|
||||
"group": "Configure",
|
||||
"pages": ["envars"]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Contributing",
|
||||
"pages": [
|
||||
"contributing",
|
||||
"codeOfConduct",
|
||||
"developing"
|
||||
]
|
||||
}
|
||||
],
|
||||
"classes": {
|
||||
"topbarCtaButton": "bg-[#BADC58] hover:opacity-80 text-black rounded-md px-7 py-2.5 font-semibold",
|
||||
"anchors": "group-hover:bg-gradient-to-br from-sky-400 to-primary",
|
||||
"activeAnchors": "bg-gradient-to-br"
|
||||
},
|
||||
"backgroundImage": "/docs/images/background.png"
|
||||
}
|
||||
@ -0,0 +1,19 @@
|
||||
---
|
||||
title: "Overview"
|
||||
description: "Options for hosting Infisical"
|
||||
---
|
||||
|
||||
<Info>
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
</Info>
|
||||
|
||||
## 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.
|
||||
@ -0,0 +1,43 @@
|
||||
---
|
||||
title: "Syncing Manually"
|
||||
description: "Infisical is a simple, end-to-end encrypted (E2EE) solution that enables teams to sync and manage their .env files in seconds."
|
||||
---
|
||||
|
||||
<iframe
|
||||
class="w-full"
|
||||
width="560"
|
||||
height="315"
|
||||
src="https://www.youtube.com/embed/DVa63Q8D2BI"
|
||||
title="YouTube video player"
|
||||
frameborder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowfullscreen
|
||||
></iframe>
|
||||
|
||||
## Background
|
||||
|
||||
The second approach that dev teams use to pull environment variables from Infisical into their local projects is to do so **manually**. This method is preferred if you wish to keep using a local .env file; the drawback here, however, is that you'll have to pull from Infisical every time you wish to sync environment variables.
|
||||
|
||||
## Steps
|
||||
|
||||
If you haven't already, be sure to perform the prerequisite steps listed in our Getting Started guide. It walks through how to set up an account, make a project, invite your team, and add your environment variables.
|
||||
|
||||
Once you've done that, return here to connect the Infisical project to your local development environment.
|
||||
|
||||
### Step 1: Pull your .env file from Infisical
|
||||
|
||||
Navigate to your root project folder containing your .env file. Now run the command below. If it's your first time, then follow the prompt to log in and connect the Infisical project to your local development environment:
|
||||
|
||||
```bash
|
||||
npx infisical pull dev
|
||||
```
|
||||
|
||||
Note: You can specify which environment you wish to pull your variables from; options include dev, staging, and prod.
|
||||
|
||||
Voila, you've just pulled your environment variables into your .env file. Don't believe it? Feel free to clear your .env file and run the command again to bring them back!
|
||||
|
||||
We've abstracted away the complex cryptography and enabled your team to securely sync secrets — if you're curious about how it all works, check out our security brief. Now you can get your team to start using the project as well.
|
||||
|
||||
We're constantly improving Infisical, so we'd love to get your feedback and take feature requests.
|
||||
|
||||
Lastly, if you have any questions or inquiries, shoot an email over to [support@infisical.com](mailto:support@infisical.com) so we can assist you. Alternatively, feel free to post your question or DM us on Slack here; we'd be happy to connect with you.
|
||||
|
After Width: | Height: | Size: 493 KiB |
|
After Width: | Height: | Size: 1.2 MiB |
|
After Width: | Height: | Size: 24 KiB |
|
After Width: | Height: | Size: 9.2 KiB |
|
After Width: | Height: | Size: 9.2 KiB |
|
After Width: | Height: | Size: 38 KiB |
|
After Width: | Height: | Size: 23 KiB |
|
After Width: | Height: | Size: 112 KiB |
Loading…
Reference in new issue