Skip to content

Commit c56a86a

Browse files
committed
remove from README
1 parent c087fb3 commit c56a86a

File tree

1 file changed

+0
-115
lines changed

1 file changed

+0
-115
lines changed

README.md

Lines changed: 0 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,6 @@ Would you also like to pull your production `.env` to your machine? Run the comm
142142
$ npx dotenv-vault@latest pull production
143143
```
144144

145-
ℹ️ **🔐 Vault Managed vs 💻 Locally Managed**: The above example, for brevity's sake, used the 🔐 Vault Managed solution to manage your `.env.vault` file. You can instead use the 💻 Locally Managed solution. [See the faq further below](#how-do-i-use--locally-managed-dotenv-vault). Our vision is that other platforms and orchestration tools adopt the `.env.vault` standard as they did the `.env` standard. We don't expect to be the only ones providing tooling to manage and generate `.env.vault` files.
146-
147145
<a href="https://www.dotenv.org/docs/tutorials/environments?r=1">Learn more about environments</a>
148146

149147
## 📚 Examples
@@ -401,10 +399,6 @@ $ npx dotenv-vault@latest help
401399
* [rotatekey](#rotatekey)
402400
* [decrypt](#decrypt)
403401
* [versions](#versions)
404-
* [local](#local-build)
405-
* [local build](#local-build)
406-
* [local decrypt](#local-decrypt)
407-
* [local keys](#local-keys)
408402

409403
### `new`
410404

@@ -814,67 +808,6 @@ If you want to pull a specific version you can do so. For example,
814808
npx dotenv-vault@latest pull development@v14
815809
```
816810

817-
---
818-
819-
### `local build`
820-
821-
Build .env.vault from local only
822-
823-
Example:
824-
825-
```bash
826-
$ npx dotenv-vault@latest local build
827-
```
828-
829-
This will encrypt the contents of your `.env` file and any `.env.ENVIRONMENT` files you have locally into your `.env.vault` file.
830-
831-
### `local decrypt`
832-
833-
Decrypt .env.vault from local only
834-
835-
Example:
836-
837-
```bash
838-
$ npx dotenv-vault@latest local decrypt dotenv://:[email protected]/vault/.env.vault?environment=development
839-
```
840-
841-
##### ARGUMENTS
842-
843-
*[DOTENV_KEY]*
844-
845-
Set `DOTENV_KEY` to decrypt .env.vault. Development key will decrypt development, production will decrypt production, and so on.
846-
847-
```
848-
$ npx dotenv-vault@latest local decrypt dotenv://:[email protected]/vault/.env.vault?environment=development
849-
```
850-
851-
### `local keys`
852-
853-
List .env.vault local decryption keys from .env.keys file
854-
855-
Example:
856-
857-
```bash
858-
$ npx dotenv-vault@latest local keys
859-
local: Listing .env.vault decryption keys from .env.keys... done
860-
environment DOTENV_KEY
861-
─────────── ────────────────────────────────────────────────────────────────────────────────────────────────────────
862-
develompent dotenv://:[email protected]/vault/.env.va…
863-
production dotenv://:[email protected]/vault/.env.va…
864-
```
865-
866-
##### ARGUMENTS
867-
868-
*[ENVIRONMENT]*
869-
870-
Set `ENVIRONMENT` to output a single environment's DOTENV_KEY.
871-
872-
```
873-
$ npx dotenv-vault@latest local keys development…
874-
local: Listing .env.vault decryption keys from .env.keys... done
875-
dotenv://:[email protected]/vault/.env.vault?environment=development
876-
```
877-
878811
## ❓ FAQ
879812

880813
### Why is the `.env.vault` file not decrypting my environment variables successfully?
@@ -928,54 +861,6 @@ The `.env.vault` file and its encryption algorithm is language-agnostic so techn
928861
* [Python](https://github.com/dotenv-org/python-dotenv-vault)
929862
* [Ruby](https://github.com/dotenv-org/dotenv-vault-ruby)
930863

931-
### How do I use 💻 Locally Managed dotenv-vault?
932-
933-
There are a series of **💻 Locally Managed** commands available to you. Locally managed never makes a remote API call. It is completely managed on your machine.
934-
935-
**🔐 Vault Managed** adds conveniences like backing up your .env file, secure sharing across your team, access permissions, and version history.
936-
937-
**💻 Locally Managed** is a good choice for someone who would prefer to handle this coordination themselves and does not want to trust Dotenv Vault with their secrets.
938-
939-
<a href="https://www.youtube.com/watch?v=Ad7Wl8iC3Rs">
940-
<div align="right">
941-
<img src="https://img.youtube.com/vi/Ad7Wl8iC3Rs/hqdefault.jpg" alt="how to deploy with a .env.vault file video tutorial" align="right" width="330" />
942-
<img src="https://simpleicons.vercel.app/youtube/ff0000" alt="youtube/@dotenvorg" align="right" width="24" />
943-
</div>
944-
</a>
945-
946-
Here's how it works.
947-
948-
Generate your `.env.vault` file.
949-
950-
```shell
951-
$ npx dotenv-vault@latest local build
952-
```
953-
954-
This creates two files:
955-
956-
* `.env.vault` - encrypted contents of .env* file(s)
957-
* `.env.keys` - decryption key(s)
958-
959-
Boot using `.env.vault`.
960-
961-
```
962-
$ DOTENV_KEY=<key string from .env.keys> npm start
963-
964-
[[email protected]][INFO] Loading env from encrypted .env.vault
965-
```
966-
967-
Great! Next, set the `DOTENV_KEY` on your server. For example in heroku:
968-
969-
```shell
970-
$ heroku config:set DOTENV_KEY=<key string from .env.keys>
971-
```
972-
973-
Commit your `.env.vault` file safely to code and deploy.
974-
975-
Your `.env.vault` is decrypted on boot, its environment variables injected, and your app works as expected.
976-
977-
Congratulations, your secrets are now much safer than scattered across multiple servers and cloud providers!
978-
979864
### Migrating to Dotenvx
980865

981866
With dotenvx you put your development, staging, ci, and production secrets IN your code - as encrypted `.env.*` files. So for example, to do production you would

0 commit comments

Comments
 (0)