Skip to content

Commit

Permalink
Add Django, Rails integration instructions to docs and move cli login…
Browse files Browse the repository at this point in the history
… to overview page
  • Loading branch information
dangtony98 committed Nov 30, 2022
1 parent c6777e4 commit 6468b35
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 19 deletions.
6 changes: 6 additions & 0 deletions docs/cli/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,9 @@ The Infisical CLI provides a way to inject environment variables from the platfo

</Tab>
</Tabs>

## Log in to the Infisical CLI

```bash
infisical login
```
16 changes: 5 additions & 11 deletions docs/cli/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:

Expand Down
18 changes: 17 additions & 1 deletion docs/integrations/frameworks/django.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,20 @@
title: "Django"
---

Instructions coming soon.
Prerequisite: [Install the CLI](/cli/overview)

## Initialize Infisical for your [Django](https://www.djangoproject.com) project

```bash
# move to your Django project
cd /path/to/project

# initialize infisical
infisical init
```

## Start your server with environment variables injected

```bash
infisical run -- python manage.py runserver
```
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Fibre"
title: "Fiber"
---

Coming soon.
2 changes: 1 addition & 1 deletion docs/integrations/frameworks/nextjs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Next.js"

Prerequisite: [Install the CLI](/cli/overview)

## Initialize Infisical for your [Next.js](https://nextjs.org)
## Initialize Infisical for your [Next.js](https://nextjs.org) app

```bash
# move to your Next.js app
Expand Down
18 changes: 17 additions & 1 deletion docs/integrations/frameworks/rails.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,20 @@
title: "Ruby on Rails"
---

Instructions coming soon.
Prerequisite: [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
```
6 changes: 3 additions & 3 deletions docs/integrations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Missing an integration? Throw in a [request](https://github.com/Infisical/infisi
| [Gatsby](/integrations/frameworks/gatsby) | Framework | Available |
| [Remix](/integrations/frameworks/remix) | Framework | Available |
| [Vite](/integrations/frameworks/vite) | Framework | Available |
| [Fibre](/integrations/frameworks/fibre) | Framework | Coming soon |
| [Django](/integrations/frameworks/django) | Framework | Coming soon |
| [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 | Coming soon |
| [Ruby on Rails](/integrations/frameworks/rails) | Framework | Available |
2 changes: 1 addition & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
"integrations/frameworks/gatsby",
"integrations/frameworks/remix",
"integrations/frameworks/vite",
"integrations/frameworks/fibre",
"integrations/frameworks/fiber",
"integrations/frameworks/django",
"integrations/frameworks/flask",
"integrations/frameworks/laravel",
Expand Down

0 comments on commit 6468b35

Please sign in to comment.