2017-04-15 17:38:05 +00:00
|
|
|
# asciinema web app
|
2012-04-03 10:03:31 +00:00
|
|
|
|
2014-08-05 14:31:51 +00:00
|
|
|
[](https://travis-ci.org/asciinema/asciinema.org)
|
2015-03-06 10:10:33 +00:00
|
|
|
[](https://codeclimate.com/github/asciinema/asciinema.org)
|
2015-03-06 10:30:48 +00:00
|
|
|
[](https://coveralls.io/r/asciinema/asciinema.org)
|
2014-02-01 09:40:57 +00:00
|
|
|
|
2014-12-17 15:46:03 +00:00
|
|
|
asciinema is a free and open source solution for recording terminal sessions
|
|
|
|
|
and sharing them on the web.
|
2012-04-09 11:44:38 +00:00
|
|
|
|
2017-04-15 17:38:05 +00:00
|
|
|
This repository contains the source code of asciinema hosting web app, which
|
|
|
|
|
runs at [asciinema.org](https://asciinema.org).
|
|
|
|
|
|
|
|
|
|
You can find the source code of asciinema terminal recorder
|
|
|
|
|
at [asciinema/asciinema](https://github.com/asciinema/asciinema), and the source
|
|
|
|
|
code of asciinema web player
|
2017-04-13 19:05:32 +00:00
|
|
|
at [asciinema/asciinema-player](https://github.com/asciinema/asciinema-player).
|
2012-04-09 11:44:38 +00:00
|
|
|
|
2017-04-15 18:43:29 +00:00
|
|
|
## Setting up your own asciinema web app instance
|
2015-10-31 10:36:46 +00:00
|
|
|
|
2017-04-15 18:43:29 +00:00
|
|
|
asciinema terminal recorder uses [asciinema.org](https://asciinema.org) as its
|
|
|
|
|
default host for the recordings. It's free, public service (all uploaded
|
|
|
|
|
recordings are __private by default__ though).
|
2015-10-31 10:37:24 +00:00
|
|
|
|
2017-04-15 18:43:29 +00:00
|
|
|
If you're not comfortable with uploading your terminal sessions to
|
|
|
|
|
asciinema.org, or your company's policy prevents you from doing that, you can
|
|
|
|
|
set up your own instance for private use. See
|
|
|
|
|
our [asciinema web app install guide](docs/INSTALL.md).
|
2015-10-28 20:38:07 +00:00
|
|
|
|
2017-04-15 18:43:29 +00:00
|
|
|
Once you have your instance running, point asciinema recorder to it by setting
|
|
|
|
|
API URL in `~/.config/asciinema/config` file as follows:
|
2017-04-13 14:44:35 +00:00
|
|
|
|
2017-04-15 18:43:29 +00:00
|
|
|
[api]
|
|
|
|
|
url = https://your.asciinema.host
|
2012-04-09 11:44:38 +00:00
|
|
|
|
2017-04-22 11:23:39 +00:00
|
|
|
Alternatively, you can set `ASCIINEMA_API_URL` environment variable:
|
|
|
|
|
|
|
|
|
|
ASCIINEMA_API_URL=https://your.asciinema.host asciinema rec
|
|
|
|
|
|
2013-12-03 19:09:18 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
2017-04-15 17:38:05 +00:00
|
|
|
Check out our [Contributing](http://asciinema.org/contributing) page, which
|
|
|
|
|
describes multiple ways you can help this project.
|
|
|
|
|
|
|
|
|
|
If you decide to contribute with the code then please
|
|
|
|
|
read [CONTRIBUTING.md](CONTRIBUTING.md), which covers submitting bugs,
|
|
|
|
|
requesting new features, preparing your code for a pull request, etc.
|
2013-12-03 19:09:18 +00:00
|
|
|
|
2017-04-15 17:52:50 +00:00
|
|
|
## Security
|
|
|
|
|
|
|
|
|
|
We're serious about the security of this web app and the user data it manages.
|
|
|
|
|
If you find anything that looks like a potential vulnerability please
|
|
|
|
|
read on
|
|
|
|
|
[how to report a security issue](CONTRIBUTING.md#reporting-security-issues).
|
|
|
|
|
|
2012-04-09 11:44:38 +00:00
|
|
|
## Authors
|
|
|
|
|
|
2017-04-15 17:38:05 +00:00
|
|
|
asciinema is developed by [Marcin Kulik](http://ku1ik.com) with the help of
|
|
|
|
|
many great open source contributors.
|
|
|
|
|
|
|
|
|
|
For a complete list of the many individuals that contributed to the project,
|
|
|
|
|
please refer to
|
|
|
|
|
[GitHub's list of contributors](https://github.com/asciinema/asciinema.org/contributors).
|
2013-10-06 11:02:37 +00:00
|
|
|
|
|
|
|
|
## Copyright
|
|
|
|
|
|
2017-04-15 17:38:05 +00:00
|
|
|
Copyright © 2011-2017 Marcin Kulik. See LICENSE.txt for details.
|
