• Stars
    star
    2,177
  • Rank 20,151 (Top 0.5 %)
  • Language
    Elixir
  • License
    Apache License 2.0
  • Created about 13 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Platform for hosting and sharing terminal session recordings

asciinema web app

asciinema is a free and open source solution for recording terminal sessions and sharing them on the web.

This repository contains the source code of asciinema hosting web app, which runs at asciinema.org.

You can find the source code of asciinema terminal recorder at asciinema/asciinema, and the source code of asciinema web player at asciinema/asciinema-player.

Setting up your own asciinema web app instance

asciinema terminal recorder uses asciinema.org as its default host for the recordings. It's free, public service (all uploaded recordings are private by default though).

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 server install guide.

Once you have your instance running, point asciinema recorder to it by setting API URL in ~/.config/asciinema/config file as follows:

[api]
url = https://your.asciinema.host

Alternatively, you can set ASCIINEMA_API_URL environment variable:

ASCIINEMA_API_URL=https://your.asciinema.host asciinema rec

Security

Security of this web app and user data it manages is important. If you find anything that looks like a potential vulnerability please read on how to report a security issue.

Consulting

I offer consulting services for asciinema project. See https://asciinema.org/consulting for more information.

Contributing

Check out our Contributing page, which describes multiple ways you can help this project.

If you decide to contribute with the code then please read CONTRIBUTING.md, which covers submitting bugs, requesting new features, preparing your code for a pull request, etc.

Authors

asciinema is developed by Marcin Kulik 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.

Copyright

Β© 2011 Marcin Kulik.

All code is licensed under the Apache License, Version 2.0. See LICENSE file for details.