Skip to content
This repository was archived by the owner on Apr 17, 2025. It is now read-only.

Commit 2444999

Browse files
authored
Update README (#50)
1 parent b23849d commit 2444999

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
# Cryptr
2+
23
Cryptr is a GUI for [Hashicorp's Vault](https://www.vaultproject.io/).
34

4-
Using Cryptr, a user may easily interact with their Vault instance's API: reading, creating, and modifying secrets with ease.
5+
Using Cryptr, a user may manage secrets in their Vault instance: reading, creating, and modifying secrets with ease.
56

67
![alt text](app/images/cryptr-demo.png "Cryptr")
78

89
## Download Binaries
910

10-
Current release can be [downloaded here](https://github.com/adobe/cryptr/releases).
11-
Cryptr supports Windows, Linux and Mac OS. It has been tested on Windows 10, Ubuntu 17.04 Desktop, and macOS 10.13 High Sierra.
11+
The current release can be [downloaded here](https://github.com/adobe/cryptr/releases).
12+
13+
Cryptr supports Windows, Linux and macOS. It has been tested on Windows 10, Ubuntu 17.04 Desktop, and macOS 10.15 Catalina.
14+
15+
On macOS, you may be warned about untrusted developers when you first attempt to launch Cryptr. To resolve this, open Finder, navigate to Applications, right-click on Cryptr.app and click Open. You can then confirm you want to allow Cryptr to be opened.
1216

1317
For *Linux*, use the `.AppImage` files. They are self-contained binaries that run on every major linux distro. Just make it executable and run it. [AppImage information here!](https://appimage.org/)
1418

@@ -21,6 +25,7 @@ brew cask install cryptr
2125
```
2226

2327
## Building from Source
28+
2429
You only need to do this if you want to contribute code, or run Cryptr in developer mode. (For Linux binaries, see above).
2530

2631
```
@@ -33,23 +38,21 @@ npm run dev
3338
## Unique Features
3439

3540
In addition to the default feature-set of Vault, Cryptr adds some things that are "nice to have". Some of these include:
36-
- Secrets can be files
41+
42+
- Files can be uploaded and downloaded directly to and from the filesystem. This includes both text and binary files.
43+
- A "share secret" features allows one user to send another user a time-limited self-destructing secret. This can be useful to send a secret to a friend without needing to change the receiving party's access in Vault.
3744
- Underscores in key names show as whitespace. ie. `secret/My_cool_Secret` shows up in the folder structure as `My cool Secret`
38-
- Ability to move secrets.
45+
- Secrets can be easily moved or renamed using a friendly UI.
3946

4047
## License
4148
Apache 2.0 License
4249

43-
## HTTPS
44-
Cryptr will ONLY access Vault servers enabled with HTTPS. These are your secrets. Keep them secret, keep them safe.
45-
46-
The only exception to this is a dev server running locally at `http://127.0.0.1:<port>`. Cryptr's URL field will automatically change to contain a `http://` prefix when `127.0.0.1:` is input. (Note the colon, which is required for the prefix to change. A port number provided after the colon is also required. For reference, a default Vault dev server is started on port 8200)
47-
4850
### Auth backends
49-
Currently LDAP, UserPass and Token auth backends are accepted. Most others are not useful for a GUI, but if you feel otherwise, submit a pull request.
5051

52+
Currently LDAP, UserPass and Token auth backends are accepted. Most others are not useful for a GUI, but if you feel otherwise, submit a pull request or open an issue.
5153

5254
# Important Notes about Policies
55+
5356
## Secret Discovery
5457

5558
Cryptr requires that policies associated with a token to be readable by that token. The purpose for this is to discover what secrets are available to the token. An example ACL for a policy found at `sys/policy/demo` would be as follows:

0 commit comments

Comments
 (0)