Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2025-12-16 11:48:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document api.url config setting

Browse Source
This commit is contained in:
Marcin Kulik
2015-03-10 15:49:35 +01:00
parent 0974ce22a6
commit 720d26744d
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -139,22 +139,27 @@ the configuration file `~/.asciinema/config`. It looks like this:
[api] [api]
token = d5a2dce4-173f-45b2-a405-ac33d7b70c5f token = d5a2dce4-173f-45b2-a405-ac33d7b70c5f
There are several options you can set in this file which relate to recording There are several options you can set in this file. Here's a config with all
behaviour. Here's a config with all available options set: available options set:
[api] [api]
token = d5a2dce4-173f-45b2-a405-ac33d7b70c5f token = d5a2dce4-173f-45b2-a405-ac33d7b70c5f
url = https://asciinema.example.com
[record] [record]
command = /bin/bash -l command = /bin/bash -l
maxwait = 2 maxwait = 2
yes = true yes = true
The options in `[record]` section have the same meaning as the options you pass The options in `[api]` section are related to API location and authentication.
to `asciinema rec` command. To tell asciinema recorder to use your own asciinema site instance rather than
the default one (asciinema.org), you can set `url` option. API URL can also be
passed via `ASCIINEMA_API_URL` environment variable.
If you happen to often use either `-c`, `-w` or `-y` with `rec` command then The options in `[record]` section have the same meaning as the options you pass
consider saving it as a default in the config file. to `asciinema rec` command. If you happen to often use either `-c`, `-w` or
`-y` with `rec` command then consider saving it as a default in the config
file.
## Contributing ## Contributing