Go to file
Marcin Kulik 779220a433 Include Date header in outgoing email messages 2023-11-13 10:29:41 +01:00
.github Move sponsor logos to assets/ 2023-10-03 10:35:55 +02:00
assets Make .txt version and .gif instructions discoverable via Download dropdown 2023-10-17 17:18:26 +02:00
config Add .txt endpoint - /a/<id>.txt 2023-10-17 12:12:14 +02:00
dev Use Postgres 14 container image 2023-02-10 22:32:52 +01:00
docker/nginx Force gzip all served asciicast files 2021-04-22 22:27:18 +02:00
lib Include Date header in outgoing email messages 2023-11-13 10:29:41 +01:00
native/vt_nif Add .txt endpoint - /a/<id>.txt 2023-10-17 12:12:14 +02:00
priv Save producer parser in db, for stats 2023-08-17 15:22:20 +02:00
rel Upgrade to Phoenix 1.6 2023-02-15 18:12:46 +01:00
test Add .txt endpoint - /a/<id>.txt 2023-10-17 12:12:14 +02:00
uploads Serve uploads from outside of public dir 2016-04-10 12:29:16 +00:00
.dockerignore Ignore Elixir language server files in docker's build context 2020-05-25 21:29:32 +02:00
.env.production.sample Add .txt endpoint - /a/<id>.txt 2023-10-17 12:12:14 +02:00
.formatter.exs Upgrade to Phoenix 1.7 2023-07-08 16:54:48 +02:00
.gitignore Add .txt endpoint - /a/<id>.txt 2023-10-17 12:12:14 +02:00
.iex.exs Rename Asciicasts context to Recordings 2023-05-15 16:33:06 +02:00
.tool-versions Upgrade Erlang, Elixir and Node.js 2023-02-11 12:41:19 +01:00
CONTRIBUTING.md Replace mentions of freenode with libera.chat 2021-11-04 17:44:06 +07:00
Dockerfile Fetch cargo deps earlier during container build 2023-10-18 11:33:01 +02:00
LICENSE Re-license the project under ASLv2 2017-06-06 13:18:57 +02:00
README.md Move sponsor logos to assets/ 2023-10-03 10:35:55 +02:00
docker-compose.yml Update registry for container image in docker compose config 2023-03-15 20:07:57 +01:00
mix.exs Post Phoenix upgrade tweaks 2023-07-08 17:40:39 +02:00
mix.lock Upgrade to Phoenix 1.7 2023-07-08 16:54:48 +02:00

README.md

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.

Shout-out to our Platinum sponsors, whose financial support helps keep the project alive:

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.

Sponsors

asciinema is sponsored by:

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.

© 2011 Marcin Kulik.

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