Update 2 files

- /docs/CHEZMOI-INTRO.md
- /home/.chezmoi.yaml.tmpl
This commit is contained in:
Brian Zalewski 2023-01-12 05:12:30 +00:00
parent b157d9fa2c
commit 8a2f7cf72a
2 changed files with 14 additions and 58 deletions

View file

@ -6,6 +6,8 @@ and then show prompts to fill in the gaps if the system is not headless. Below y
a description of what each piece of information is used for as well as the name of the a description of what each piece of information is used for as well as the name of the
environment variable you can specify to bypass the prompt. environment variable you can specify to bypass the prompt.
If a description starts off with **Environment Variable Only** then the prompt system will not ask you for the default value. Instead, you should run `export VARIABLE_NAME="VALUE_HERE"` for each value you want to utilize before you proceed with the provisioning.
### Work Environment ### Work Environment
Set to true if you are setting up a work environment where things like Tor should Set to true if you are setting up a work environment where things like Tor should
@ -42,7 +44,7 @@ Enter your primary e-mail address.
### Public GPG Key ID ### Public GPG Key ID
If you have a public GPG key available on the Ubuntu or MIT keyservers, then you can enter it **Environment Variable Only** If you have a public GPG key available on the Ubuntu or MIT keyservers, then you can enter it
so that it is automatically imported. so that it is automatically imported.
* Environment variable: `KEYID` * Environment variable: `KEYID`
@ -69,58 +71,51 @@ records.
### GitHub Gist Token ### GitHub Gist Token
Pass in a GitHub token with the `gist` scope to be able to use the `gist` CLI tool without having to authenticate. **Environment Variable Only** Pass in a GitHub token with the `gist` scope to be able to use the `gist` CLI tool without having to authenticate.
* Environment variable: `GITHUB_GIST_TOKEN` * Environment variable: `GITHUB_GIST_TOKEN`
### GitHub Read-Only Token ### GitHub Read-Only Token
Pass in a GitHub read-only token linked to your account to automatically save a backup of your **Environment Variable Only** Pass in a GitHub read-only token linked to your account to automatically save a backup of your
GitHub repositories. For more information, see [this link](https://github.com/gabrie30/ghorg#scm-provider-setup). GitHub repositories. For more information, see [this link](https://github.com/gabrie30/ghorg#scm-provider-setup).
* Environment variable: `GITHUB_READ_TOKEN` * Environment variable: `GITHUB_READ_TOKEN`
### GitLab Read-Only Token ### GitLab Read-Only Token
Pass in a GitLab read-only token linked to your account to automatically save a backup of your **Environment Variable Only** Pass in a GitLab read-only token linked to your account to automatically save a backup of your
GitLab repositories. For more information, see [this link](https://github.com/gabrie30/ghorg#scm-provider-setup). GitLab repositories. For more information, see [this link](https://github.com/gabrie30/ghorg#scm-provider-setup).
* Environment variable: `GITLAB_READ_TOKEN` * Environment variable: `GITLAB_READ_TOKEN`
### G-mail Address ### G-mail Address
Add a G-mail address which you would like to use as the handler for outgoing SMTP mail. **Environment Variable Only** Add a G-mail address which you would like to use as the handler for outgoing SMTP mail.
* Environment variable: `GMAIL_ADDRESS` * Environment variable: `GMAIL_ADDRESS`
### G-mail App Password ### G-mail App Password
Add the app password to your G-mail address so that outgoing mail can be handled by G-mail. **Environment Variable Only** Add the app password to your G-mail address so that outgoing mail can be handled by G-mail.
* Environment variable: `GMAIL_APP_PASSWORD` * Environment variable: `GMAIL_APP_PASSWORD`
### Ngrok Authentication Token ### Ngrok Authentication Token
Add your Ngrok authentication token so that the configuration file can be automatically **Environment Variable Only** Add your Ngrok authentication token so that the configuration file can be automatically
generated. generated.
* Environment Variable: `NGROK_AUTH_TOKEN` * Environment Variable: `NGROK_AUTH_TOKEN`
### Slack API Token ### Slack API Token
Add your Slack API token so that `slackterm` can be automatically set up. **Environment Variable Only** Add your Slack API token so that `slackterm` can be automatically set up.
* Environment Variable: `SLACK_API_TOKEN` * Environment Variable: `SLACK_API_TOKEN`
### Tabby Configuration ID ### Tailscale Auth Key
Add your Tabby configuration ID to automatically sync Tabby settings. **Environment Variable Only** Add a Tailscale authentication key so that Tailscale can be automatically connected to your Tailscale network.
* Environment Variable: `TABBY_CONFIG_ID` * Environment Variable: `TAILSCALE_AUTH_KEY`
### Tabby Sync Token
Add your Tabby sync token to automatically sync Tabby settings. This works in conjunction with
the Tabby Configuration ID mentioned above.
* Environment Variable: `TABBY_SYNC_TOKEN`

View file

@ -85,7 +85,7 @@
{{- $withToolchain := env (list "WITH" (upper $toolchain) | join "_") -}} {{- $withToolchain := env (list "WITH" (upper $toolchain) | join "_") -}}
{{- if and (or $withoutToolchains $withoutToolchain) (not $withToolchain) -}} {{- if and (or $withoutToolchains $withoutToolchain) (not $withToolchain) -}}
{{- writeToStdout (list "Disabled" $toolchain "toolchain.\n" | join " ") -}} {{- writeToStdout (list "Disabled" $toolchain "toolchain.\n" | join " ") -}}
{{- $_ := set $toolchainsEnabled $toolchain false }} {{- $_ := set $toolchainsEnabled $toolchain true }}
{{- else }} {{- else }}
{{- $_ := set $toolchainsEnabled $toolchain true }} {{- $_ := set $toolchainsEnabled $toolchain true }}
{{- end}} {{- end}}
@ -93,15 +93,6 @@
{{- if stdinIsATTY -}} {{- if stdinIsATTY -}}
{{- range $toolchain := $toolchains }}
{{- $enabled := promptBoolOnce $data.toolchains $toolchain (list "Enable" $toolchain "toolchain" | join " ") (get $toolchainsEnabled $toolchain) -}}
{{- if and (eq $toolchain "Kubernetes") $enabled (not $toolchainsEnabled.Docker) -}}
{{- $_ := set $toolchainsEnabled "Docker" $enabled }}
{{- writeToStdout "Enabled Docker toolchain to support Kubernetes.\n" -}}
{{- end -}}
{{- $_ := set $toolchainsEnabled $toolchain $enabled }}
{{- end }}
{{- if not (env "WORK_ENVIRONMENT") -}} {{- if not (env "WORK_ENVIRONMENT") -}}
{{- $work = promptBoolOnce $data.host "work" "Work environment" $work -}} {{- $work = promptBoolOnce $data.host "work" "Work environment" $work -}}
{{- end -}} {{- end -}}
@ -117,9 +108,6 @@
{{- if not (env "PRIMARY_EMAIL") -}} {{- if not (env "PRIMARY_EMAIL") -}}
{{- $email = promptStringOnce $data.user "email" "Primary e-mail address" $email -}} {{- $email = promptStringOnce $data.user "email" "Primary e-mail address" $email -}}
{{- end -}} {{- end -}}
{{- if not (env "KEYID") -}}
{{- $gpgKeyId = promptStringOnce $data.user "gpgKeyId" "Public GPG key ID" $gpgKeyId -}}
{{- end -}}
{{- if not (env "PUBLIC_SERVICES_DOMAIN") -}} {{- if not (env "PUBLIC_SERVICES_DOMAIN") -}}
{{- $domain = promptStringOnce $data.user "domain" "Domain name" $domain -}} {{- $domain = promptStringOnce $data.user "domain" "Domain name" $domain -}}
{{- end -}} {{- end -}}
@ -129,33 +117,6 @@
{{- if not (env "CLOUDFLARE_TOKEN") -}} {{- if not (env "CLOUDFLARE_TOKEN") -}}
{{- $cloudflareToken = promptStringOnce $data.user "cloudflareToken" "CloudFlare API Token" $cloudflareToken -}} {{- $cloudflareToken = promptStringOnce $data.user "cloudflareToken" "CloudFlare API Token" $cloudflareToken -}}
{{- end -}} {{- end -}}
{{- if not (env "GITHUB_USERNAME") -}}
{{- $githubUsername = promptStringOnce $data.user "githubUsername" "GitHub username" $githubUsername -}}
{{- end -}}
{{- if not (env "GITHUB_GIST_TOKEN") -}}
{{- $githubGistToken = promptStringOnce $data.user "githubGistToken" "GitHub Gist token" $githubGistToken -}}
{{- end -}}
{{- if not (env "GITLAB_READ_TOKEN") -}}
{{- $gitlabReadToken = promptStringOnce $data.user "gitlabReadToken" "GitLab read-only token" $gitlabReadToken }}
{{- end -}}
{{- if not (env "GITHUB_READ_TOKEN") -}}
{{- $githubReadToken = promptStringOnce $data.user "githubReadToken" "GitHub read-only token" $githubReadToken }}
{{- end -}}
{{- if not (env "GMAIL_ADDRESS") -}}
{{- $gmailAddress = promptStringOnce $data.user "gmailAddress" "G-mail address" $gmailAddress -}}
{{- end -}}
{{- if not (env "GMAIL_APP_PASSWORD") -}}
{{- $gmailAddressAppPassword = promptStringOnce $data.user "gmailAddressAppPassword" "G-mail app password" $gmailAddressAppPassword -}}
{{- end -}}
{{- if not (env "NGROK_AUTH_TOKEN") -}}
{{- $ngrokAuthToken = promptStringOnce $data.user "ngrokAuthToken" "Ngrok authentication token" $ngrokAuthToken -}}
{{- end -}}
{{- if not (env "SLACK_API_TOKEN") -}}
{{- $slackApiToken = promptStringOnce $data.user "slackApiToken" "Slack API token" $slackApiToken -}}
{{- end -}}
{{- if not (env "TAILSCALE_AUTH_KEY") -}}
{{- $tailscaleAuthKey = promptStringOnce $data.user "tailscaleAuthKey" "Tailscale authentication key" $tailscaleAuthKey -}}
{{- end -}}
{{- else -}} {{- else -}}
{{- $headless = true -}} {{- $headless = true -}}