updating docs #384
Merged
updating docs #384
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Zamiell
commented
Oct 6, 2017
| @@ -27,9 +27,9 @@ The slightly more awesome Standard Unix Password Manager for Teams. Written in G | |||
|
|
|||
| > Password management should be simple and follow [Unix philosophy](http://en.wikipedia.org/wiki/Unix_philosophy). With `pass`, each secret lives inside of a `gpg` encrypted file whose filename is the title of the website or resource that requires the secret. These encrypted files may be organized into meaningful folder hierarchies, copied from computer to computer, and, in general, manipulated using standard command line file management utilities. - [passwordstore.org](https://www.passwordstore.org/) | |||
|
|
|||
| `gopass` is a rewrite of `pass` in [Go](https://golang.org/) with the aim of making it cross-platform and [adding additional features](#features). Our target audience are professional developers and sysadmins (and especially teams of those) who are well versed with a command line interface. One explicit goal for this project is to make it more approachable to non-technical users. We go by the UNIX philosophy and try to do one thing and do it well, providing a stellar user experience and a sane, simple interface. | |||
| *gopass* is a rewrite of the *pass* password manager in [Go](https://golang.org/) with the aim of making it cross-platform and [adding additional features](#features). Our target audience are professional developers and sysadmins (and especially teams of those) who are well versed with a command line interface. One explicit goal for this project is to make it more approachable to non-technical users. We go by the UNIX philosophy and try to do one thing and do it well, providing a stellar user experience and a sane, simple interface. | |||
There was a problem hiding this comment.
Here, I begin the work of standardizing stylization of gopass to not use backticks
Zamiell
commented
Oct 6, 2017
| @@ -1,28 +0,0 @@ | |||
| # Known Limitations and Caveats | |||
There was a problem hiding this comment.
this is combined with the security section; i think it makes more sense that way
Zamiell
commented
Oct 6, 2017
| If a config exists it will attempt to parse and load the settings. If this | ||
| fails program execution aborts. If `gopass` can not start because of broken | ||
| or incompatible config file move it away (make a backup) and start fresh. | ||
| During startup, gopass will look for a configuration file at `$HOME/.config/gopass/config.yml`. If one is not present, it will create one. If the config file already exists, it will attempt to parse it and load the settings. If this fails, the program will abort. Thus, if gopass is giving you trouble with a broken or incompatible configuration file, simply rename it or delete it. |
There was a problem hiding this comment.
having the default config location here is obviously a must
Zamiell
commented
Oct 6, 2017
| @@ -2,11 +2,44 @@ | |||
|
|
|||
| ## Standard Features | |||
|
|
|||
| ### Data Organization | |||
There was a problem hiding this comment.
this section was in setup.md, which was a mistake. i migrated it here and fleshed it out
Zamiell
commented
Oct 6, 2017
| @@ -89,18 +122,15 @@ The generated password for golang.org/gopher is: | |||
| Eech4ahRoy2oowi0ohl | |||
| ``` | |||
|
|
|||
| The `generate` command will ask for any missing arguments, like the name of the | |||
There was a problem hiding this comment.
Standardization of no line breaks style here, as well as in other places
Zamiell
commented
Oct 6, 2017
|
|
||
| ### Ultimate Goals of Security | ||
| ## Security Goals |
There was a problem hiding this comment.
rewrote this so that it matches CIA/NP triad
Zamiell
commented
Oct 6, 2017
| name of the secrets. | ||
| * **Integrity** - Ensure that only authorized parties are allowed to modify data. | ||
| * gopass makes no attempt at protecting the integrity of a store. However, we plan to do this in the future. | ||
| * **Availability** - Secrets must always be readable by exactly the specified recipients. |
There was a problem hiding this comment.
added a note here on availability
Zamiell
commented
Oct 6, 2017
| @@ -71,25 +70,11 @@ Now, you have created a public and private key pair. If you don't know what that | |||
| * ["git + gpg, know thy commits" at coderwall](https://coderwall.com/p/d3uo3w/git-gpg-know-thy-commits) | |||
| * ["Generating a new GPG key" by GitHub](https://help.github.com/articles/generating-a-new-gpg-key/) | |||
|
|
|||
| ### Securing Your Editor | |||
There was a problem hiding this comment.
moved to post installation steps
dominikschulz
approved these changes
Oct 6, 2017
kpitt
pushed a commit
to kpitt/gopass
that referenced
this pull request
Jul 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.