Skip to content

Commit fd1c2a3

Browse files
docs: Update README to explain passcmd usage in zuliprc.
1 parent 6da7b0d commit fd1c2a3

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,12 @@ to get the hang of things.
207207

208208
## Configuration
209209

210+
configuration conssist of two file:
211+
- zulip_key, file contains the api_key
212+
- zuliprc, file consist of login configurations
213+
214+
The `zulip_key`contains only the api_key.
215+
210216
The `zuliprc` file contains two sections:
211217
- an `[api]` section with information required to connect to your Zulip server
212218
- a `[zterm]` section with configuration specific to `zulip-term`
@@ -216,13 +222,15 @@ A file with only the first section can be auto-generated in some cases by
216222
above). Parts of the second section can be added and adjusted in stages when
217223
you wish to customize the behavior of `zulip-term`.
218224

225+
If you’re downloading the config file from your Zulip account, you should replace the `key` field with `passcmd`, setting its value to a command that outputs the api_key (e.g., cat zulip_key). If you’re not downloading it manually, zulip-term will configure this for you automatically, though it’s recommended to update the passcmd value afterward for better security.
226+
219227
The example below, with dummy `[api]` section contents, represents a working
220228
configuration file with all the default compatible `[zterm]` values uncommented
221229
and with accompanying notes:
222230
```
223231
[api]
224232
225-
key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
233+
passcmd=cat zulip_key
226234
site=https://example.zulipchat.com
227235
228236
[zterm]
@@ -257,6 +265,7 @@ transparency=disabled
257265
# editor: nano
258266
```
259267

268+
260269
> **NOTE:** Most of these configuration settings may be specified on the
261270
command line when `zulip-term` is started; `zulip-term -h` or `zulip-term --help`
262271
will give the full list of options.

0 commit comments

Comments
 (0)