Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.87 KB

README.md

File metadata and controls

70 lines (52 loc) · 2.87 KB

asciinema server

asciinema server is a server-side component of the asciinema ecosystem.

It implements a hosting platform for terminal session recordings. This includes an API endpoint for uploading recordings, which is used by the asciinema CLI, and offers a familiar web interface for viewing, browsing, sharing and managing recordings.

The server is built with Elixir language and Phoenix framework, and embeds asciinema's virtual terminal, avt, to perform tasks such as preview generation and recording analysis.

asciinema.org is a public asciinema server instance managed by the asciinema team, offering free hosting for terminal recordings, available to everyone. Check asciinema.org/about to learn more about this instance.

You can easily self-host asciinema server and use the asciinema CLI with your own instance. If you're not comfortable with uploading your terminal sessions to asciinema.org, if your company policy prevents you from doing so, or if you simply prefer self-hosting everything, then asciinema has you covered.

Notable features:

  • hosting of terminal session recordings in asciicast format,
  • perfectly integrated asciinema player for best viewing experience,
  • easy sharing of recordings via secret links,
  • easy embedding of the player, or linking via preview images (SVG),
  • privacy friendly - no tracking, no ads,
  • visibility control for recordings: unlisted (secret) or public,
  • editable recording metadata like title or long description (Markdown),
  • configurable terminal themes and font families,
  • ability to download plain text version (.txt) of a recording.

Refer to asciinema server docs for further details.

Donations

Sustainability of asciinema development relies on donations and sponsorships.

Please help the software project you use and love. Become a supporter or a corporate sponsor.

asciinema is sponsored by:

Consulting

If you're interested in hosting, maintenance or customization of asciinema server, check asciinema consulting services.

Copyright

© 2011 Marcin Kulik.

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