-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
48 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,82 +1,48 @@ | ||
| # 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](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 | ||
| at [asciinema/asciinema-player](https://github.com/asciinema/asciinema-player). | ||
|
|
||
| Shout-out to our Platinum [sponsors](https://github.com/sponsors/ku1ik), whose | ||
| financial support helps keep the project alive: | ||
|
|
||
| [<img src="./assets/static/images/sponsor-logos/dashcam/logo-on-light.png" width="200" />](https://dashcam.io?utm_source=asciinemagithub) | ||
|
|
||
| ## Setting up your own asciinema web app instance | ||
|
|
||
| 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). | ||
|
|
||
| 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](https://github.com/asciinema/asciinema-server/wiki/Installation-guide). | ||
|
|
||
| Once you have your instance running, point asciinema recorder to it by setting | ||
| API URL in `~/.config/asciinema/config` file as follows: | ||
|
|
||
| ```ini | ||
| [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](https://github.com/asciinema/asciinema-server/blob/main/CONTRIBUTING.md#reporting-security-issues). | ||
|
|
||
| ## Sponsors | ||
|
|
||
| asciinema is sponsored by: | ||
|
|
||
| - [**Dashcam**](https://dashcam.io?utm_source=asciinemagithub) | ||
| - [Brightbox](https://www.brightbox.com/) | ||
|
|
||
| ## Consulting | ||
|
|
||
| I offer consulting services for asciinema project. See https://asciinema.org/consulting for more information. | ||
|
|
||
| ## Contributing | ||
|
|
||
| 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](https://github.com/asciinema/asciinema-server/blob/main/CONTRIBUTING.md), which covers submitting bugs, | ||
| requesting new features, preparing your code for a pull request, etc. | ||
|
|
||
| ## Authors | ||
|
|
||
| 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-server/contributors). | ||
|
|
||
| ## Copyright | ||
|
|
||
| © 2011 Marcin Kulik. | ||
|
|
||
| All code is licensed under the Apache License, Version 2.0. See LICENSE file for details. | ||
| # 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](../cli/index.md), and offers a familiar web interface for viewing, | ||
| browsing, sharing and managing recordings. It's privacy friendly, serving no ads | ||
| and performing no tracking. | ||
|
|
||
| The server is built with [Elixir language](https://elixir-lang.org/) and | ||
| [Phoenix framework](https://www.phoenixframework.org/), and embeds asciinema's | ||
| virtual terminal, [avt](https://github.com/asciinema/avt), to perform tasks such | ||
| as preview generation and recording analysis. | ||
|
|
||
| [asciinema.org](https://asciinema.org) is a public asciinema server instance | ||
| managed by the asciinema team, offering free hosting for terminal recordings, | ||
| available to everyone. Read [About asciinema.org](dot-org.md) to learn more | ||
| about this instance. | ||
|
|
||
| asciinema server is self-hosting friendly, and can be deployed in any | ||
| containerized environment, both for public or internal/private use. 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. | ||
| Read the [self-hosting quick start guide](self-hosting/quick-start.md) for | ||
| deployment overview. | ||
|
|
||
| --- | ||
|
|
||
| Notable features: | ||
|
|
||
| - hosting of terminal session recordings in [asciicast](../asciicast/v2.md) | ||
| format, | ||
| - perfectly integrated [asciinema player](../player/index.md) for best viewing | ||
| experience, | ||
| - editable recording metadata like title or long description (Markdown), | ||
| - configurable terminal themes and font families, | ||
| - easy [sharing](sharing.md) of recordings via secret links, | ||
| - easy [embedding](embedding.md) of the player, or linking via preview images | ||
| (SVG), | ||
| - ability to download pure text version (`.txt`) of a recording, | ||
| - visibility control for recordings: unlisted (secret) or public. | ||
|
|
||
| --- | ||
|
|
||
| asciinema server is free and open-source software (FOSS). Source code and | ||
| license available at | ||
| [github.com/asciinema/asciinema-server](https://github.com/asciinema/asciinema-server). |