|
1 |
| -# asciinema web app |
| 1 | +# asciinema server |
2 | 2 |
|
3 |
| -asciinema is a free and open source solution for recording terminal sessions |
4 |
| -and sharing them on the web. |
| 3 | +__asciinema server__ is a server-side component of the asciinema ecosystem. |
5 | 4 |
|
6 |
| -This repository contains the source code of asciinema hosting web app, which |
7 |
| -runs at [asciinema.org](https://asciinema.org). |
| 5 | +It implements a hosting platform for terminal session recordings. This includes |
| 6 | +an API endpoint for uploading recordings, which is used by the [asciinema |
| 7 | +CLI](https://docs.asciinema.org/manual/cli/), and offers a familiar web |
| 8 | +interface for viewing, browsing, sharing and managing recordings. |
8 | 9 |
|
9 |
| -You can find the source code of asciinema terminal recorder |
10 |
| -at [asciinema/asciinema](https://github.com/asciinema/asciinema), and the source |
11 |
| -code of asciinema web player |
12 |
| -at [asciinema/asciinema-player](https://github.com/asciinema/asciinema-player). |
| 10 | +The server is built with [Elixir language](https://elixir-lang.org/) and |
| 11 | +[Phoenix framework](https://www.phoenixframework.org/), and embeds asciinema's |
| 12 | +virtual terminal, [avt](https://github.com/asciinema/avt), to perform tasks such |
| 13 | +as preview generation and recording analysis. |
13 | 14 |
|
14 |
| -## Setting up your own asciinema web app instance |
15 |
| - |
16 |
| -asciinema terminal recorder uses [asciinema.org](https://asciinema.org) as its |
17 |
| -default host for the recordings. It's free, public service (all uploaded |
18 |
| -recordings are __private by default__ though). |
| 15 | +[asciinema.org](https://asciinema.org) is a public asciinema server instance |
| 16 | +managed by the asciinema team, offering free hosting for terminal recordings, |
| 17 | +available to everyone. Check [asciinema.org/about](https://asciinema.org/about) |
| 18 | +to learn more about this instance. |
19 | 19 |
|
| 20 | +You can easily [self-host asciinema |
| 21 | +server](https://docs.asciinema.org/manual/server/self-hosting/) and use the |
| 22 | +[asciinema CLI](https://docs.asciinema.org/manual/cli/) with your own instance. |
20 | 23 | If you're not comfortable with uploading your terminal sessions to
|
21 |
| -asciinema.org, or your company's policy prevents you from doing that, you can |
22 |
| -set up your own instance for private use. See |
23 |
| -our [asciinema server install guide](https://github.com/asciinema/asciinema-server/wiki/Installation-guide). |
| 24 | +asciinema.org, if your company policy prevents you from doing so, or if you |
| 25 | +simply prefer self-hosting everything, then asciinema has you covered. |
24 | 26 |
|
25 |
| -Once you have your instance running, point asciinema recorder to it by setting |
26 |
| -API URL in `~/.config/asciinema/config` file as follows: |
| 27 | +Notable features: |
27 | 28 |
|
28 |
| -```ini |
29 |
| -[api] |
30 |
| -url = https://your.asciinema.host |
31 |
| -``` |
| 29 | +- hosting of terminal session recordings in |
| 30 | + [asciicast](https://docs.asciinema.org/manual/asciicast/v2/) format, |
| 31 | +- perfectly integrated [asciinema |
| 32 | + player](https://docs.asciinema.org/manual/player/) for best viewing experience, |
| 33 | +- easy [sharing](https://docs.asciinema.org/manual/server/sharing/) of |
| 34 | + recordings via secret links, |
| 35 | +- easy [embedding](https://docs.asciinema.org/manual/server/embedding/) of the |
| 36 | + player, or linking via preview images (SVG), |
| 37 | +- privacy friendly - no tracking, no ads, |
| 38 | +- visibility control for recordings: unlisted (secret) or public, |
| 39 | +- editable recording metadata like title or long description (Markdown), |
| 40 | +- configurable terminal themes and font families, |
| 41 | +- ability to download pure text version (`.txt`) of a recording. |
32 | 42 |
|
33 |
| -Alternatively, you can set `ASCIINEMA_API_URL` environment variable: |
| 43 | +Refer to [asciinema server docs](https://docs.asciinema.org/manual/server/) for |
| 44 | +further details. |
34 | 45 |
|
35 |
| - ASCIINEMA_API_URL=https://your.asciinema.host asciinema rec |
| 46 | +## Donations |
36 | 47 |
|
37 |
| -## Security |
| 48 | +Sustainability of asciinema development relies on donations and sponsorships. |
38 | 49 |
|
39 |
| -Security of this web app and user data it manages is important. |
40 |
| -If you find anything that looks like a potential vulnerability please |
41 |
| -read on |
42 |
| -[how to report a security issue](https://github.com/asciinema/asciinema-server/blob/main/CONTRIBUTING.md#reporting-security-issues). |
| 50 | +Please help the software project you use and love. Become a |
| 51 | +[supporter](https://docs.asciinema.org/donations/#individuals) or a [corporate |
| 52 | +sponsor](https://docs.asciinema.org/donations/#corporate-sponsorship). |
43 | 53 |
|
44 |
| -## Sponsors |
| 54 | +asciinema is sponsored by: |
45 | 55 |
|
46 | 56 | - [Brightbox](https://www.brightbox.com/)
|
47 | 57 |
|
48 | 58 | ## Consulting
|
49 | 59 |
|
50 |
| -I offer consulting services for asciinema project. See https://asciinema.org/consulting for more information. |
51 |
| - |
52 |
| -## Contributing |
53 |
| - |
54 |
| -Check out our [Contributing](http://asciinema.org/contributing) page, which |
55 |
| -describes multiple ways you can help this project. |
56 |
| - |
57 |
| -If you decide to contribute with the code then please |
58 |
| -read [CONTRIBUTING.md](https://github.com/asciinema/asciinema-server/blob/main/CONTRIBUTING.md), which covers submitting bugs, |
59 |
| -requesting new features, preparing your code for a pull request, etc. |
60 |
| - |
61 |
| -## Authors |
62 |
| - |
63 |
| -asciinema is developed by [Marcin Kulik](http://ku1ik.com) with the help of |
64 |
| -many great open source contributors. |
65 |
| - |
66 |
| -For a complete list of the many individuals that contributed to the project, |
67 |
| -please refer to |
68 |
| -[GitHub's list of contributors](https://github.com/asciinema/asciinema-server/contributors). |
| 60 | +If you're interested in hosting, maintenance or customization of asciinema |
| 61 | +server, check [asciinema consulting |
| 62 | +services](https://docs.asciinema.org/consulting/). |
69 | 63 |
|
70 | 64 | ## Copyright
|
71 | 65 |
|
72 | 66 | © 2011 Marcin Kulik.
|
73 | 67 |
|
74 |
| -All code is licensed under the Apache License, Version 2.0. See LICENSE file for details. |
| 68 | +All code is licensed under the Apache License, Version 2.0. See LICENSE file for |
| 69 | +details. |
0 commit comments