Add key and configuration info
Dependencies
- [2]
4KH6BMBXadd Windows instructions to Installing and Getting Started pages - [3]
VLTCDWTCMoved files (new permissions format) - [4]
ZWSQJGNX - [5]
LYR3UWPMAdd workflows chapter with page about channels - [6]
RHX42ABSFix default.nix - [7]
AJ32E5LBAdd custom.css to justify align content paragraphs and enable hyphenation - [8]
SCSV2FNSReboot - [9]
U676QFJFAdd info about author name to “getting started” - [10]
GLUD3ZVFGenerating the reference - [11]
AFXHW7MXSwapped associativity figures
Change contents
- file move: src → src
- file addition: keys.md[5.6]
# Pijul keysPijul keys are used to identify patch authors in a manner which provides greater security and control than simply mapping authors to a name and email address. The inclusion of a name and email address can be spoofed in a way that a key signature cannot. In addition, Pijul plans to take advantage of the fact that a user's name and e-mail address are no longer tied to their submitted patches, allowing users to later change the name and e-mail address that other users see when they look at previously submitted patches.The keys Pijul uses to identify path authors are independent of any SSH keys a user may have to interact with a remote. SSH keys are purely for authorizing the transport of patches to/from the Nest, and are not part of Pijul as a version control system.## Generating keysUsers can generate a new key using `pijul key generate <name>`. The name used for this key is not required to bear any relationship to a nest username or SSH identity. During key generation, users will be asked for a password; on success, the location of the generated key will be displayed to the user (it should be the same directory as your [global configuration](configuration.md)). Pijul currently allows for the generation of one key at a time.## Proving keys`pijul key prove [options] <remote>` is used to associate a key with a remote/nest identity. Patches submitted before using `pijul prove` will show only the key as the author.Example (after key generation) :```pijul key prove <your_username>@ssh.pijul.com``` - edit in src/getting_started.md at line 19
Before recording, new users will need to generate a key using `pijul key generate <name>`.Users can read more about keys in [the manual section on keys](keys.md). - replacement in src/getting_started.md at line 44
`~/.pijulconfig` (MacOS).`~/.pijulconfig` (MacOS). Information about the configuration hierarchies used by pijul can be foundin the [manual section on configuration](configuration.md). - file addition: configuration.md[5.6]
# ConfigurationPijul is configured using `config.toml` files; users can take advantage of both global and repository-specific configuration.## Global configurationThe location of Pijul's global configuration depends on the conventions of the user's operating system; Pijul will first try to instantiate a global configuration in the user's congiruation directory according to [this table](https://docs.rs/dirs-next/2.0.0/dirs_next/fn.config_dir.html). If pijul cannot access the conventional config location, it will fall back to the [home directory](https://docs.rs/dirs-next/2.0.0/dirs_next/fn.home_dir.html), using `$HOME/.config/pijul`. If that fails, `$HOME/.pijulconfig` will be tried as a last resort.## Repository configurationUsers can take advantage of repository-specific configuration by editing the appropriate toml file: `<repo>/.pijul/config.toml`. Repository-specific configuration settings have a higher precedence than global configuration settings.## IgnoreItems in a repository can be ignored by editing a repository's `.ignore` file. Pijul supports standard glob syntax in `.ignore` files. - edit in src/SUMMARY.md at line 8
- [Pijul keys](./keys.md)- [Configuration](./configuration.md) - file move: generate-reference → generate-reference
- file move: default.nix → default.nix
- file move: book.toml → book.toml
- file move: README.md → README.md
- file move: LICENSE → LICENSE
- file addition: keys.md[5.6]
# Pijul keysPijul keys are used to identify patch authors in a manner which provides greater security and control than simply mapping authors to a name and email address. The inclusion of a name and email address can be spoofed in a way that a key signature cannot. In addition, Pijul plans to take advantage of the fact that a user's name and e-mail address are no longer tied to their submitted patches, allowing users to later change the name and e-mail address that other users see when they look at previously submitted patches.The keys Pijul uses to identify path authors are independent of any SSH keys a user may have to interact with a remote. SSH keys are purely for authorizing the transport of patches to/from the Nest, and are not part of Pijul as a version control system.## Generating keysUsers can generate a new key using `pijul key generate <name>`. The name used for this key is not required to bear any relationship to a nest username or SSH identity. During key generation, users will be asked for a password; on success, the location of the generated key will be displayed to the user (it should be the same directory as your [global configuration](configuration.md)). Pijul currently allows for the generation of one key at a time.## Proving keys`pijul key prove [options] <remote>` is used to associate a key with a remote/nest identity. Patches submitted before using `pijul prove` will show only the key as the author.Example (after key generation) :```pijul key prove <your_username>@ssh.pijul.com``` - file addition: configuration.md[5.6]
# ConfigurationPijul is configured using `config.toml` files; users can take advantage of both global and repository-specific configuration.## Global configurationThe location of Pijul's global configuration depends on the conventions of the user's operating system; Pijul will first try to instantiate a global configuration in the user's congiruation directory according to [this table](https://docs.rs/dirs-next/2.0.0/dirs_next/fn.config_dir.html). If pijul cannot access the conventional config location, it will fall back to the [home directory](https://docs.rs/dirs-next/2.0.0/dirs_next/fn.home_dir.html), using `$HOME/.config/pijul`. If that fails, `$HOME/.pijulconfig` will be tried as a last resort.## Repository configurationUsers can take advantage of repository-specific configuration by editing the appropriate toml file: `<repo>/.pijul/config.toml`. Repository-specific configuration settings have a higher precedence than global configuration settings.## IgnoreItems in a repository can be ignored by editing a repository's `.ignore` file. Pijul supports standard glob syntax in `.ignore` files.