asciinema hosting web app
Go to file
2015-04-03 16:48:37 +00:00
app Refactor handling of auth token for pre 0.9.9 clients 2015-04-03 16:48:37 +00:00
bin Refactor PNG generation 2015-03-29 14:15:05 +00:00
config Refactor handling of auth token for pre 0.9.9 clients 2015-04-03 16:48:37 +00:00
db Use "display" width in HTML image links 2015-03-27 17:33:50 +00:00
doc Fresh Rails 3.1 app with DM 1.2 and RSpec 2.7 2011-11-21 22:36:42 +01:00
lib Upgrate to Rails 4.1.5 2014-08-30 20:10:49 +02:00
public Improved left/right margin for guru meditation 2014-10-25 21:19:28 +02:00
script Remove unused LOCAL_PERSONA_JS env var 2015-03-06 10:37:42 +00:00
spec Refactor handling of auth token for pre 0.9.9 clients 2015-04-03 16:48:37 +00:00
src Create bin dir when compiling terminal binary 2013-09-21 13:42:52 +02:00
vendor Use latest player css 2015-03-27 11:32:22 +00:00
.env.example Unicorn with girl_friday on Heroku 2012-06-09 15:25:43 +02:00
.gitignore Use flat config files 2013-12-09 19:03:22 +01:00
.rspec.example Example .rspec config file 2012-11-23 20:53:59 +01:00
.ruby-version Use ruby 2.1 in development 2014-01-27 18:04:49 +01:00
.travis.yml Try harder, bundler 2014-11-29 12:35:55 +00:00
config.ru Load unicorn worker killer only in production 2014-01-29 16:00:24 +01:00
Gemfile Refactor PNG generation 2015-03-29 14:15:05 +00:00
Gemfile.lock Refactor PNG generation 2015-03-29 14:15:05 +00:00
Guardfile Upgrate to Rails 4.1.5 2014-08-30 20:10:49 +02:00
LICENSE Change license to AGPL v3 2014-04-04 18:36:28 +02:00
Procfile Make foreman start sidekiq with proper config file path 2013-09-14 13:12:32 +02:00
Rakefile Upgrate to Rails 4.1.5 2014-08-30 20:10:49 +02:00
README.md Add PNG generation (https://asciinema.org/a/17654.png) 2015-03-27 11:42:14 +00:00
sidekiq.ru Add rake task for starting sidekiq web panel 2013-09-14 13:11:20 +02:00

asciinema.org

Build Status Code Climate Coverage Status

Record and share your terminal sessions, the right way.

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

This is the source code of asciinema.org website. If you're looking for asciinema's terminal recorder go here: asciinema/asciinema

Setup instructions

Below you'll find setup instructions in case you want to contribute, play with it on your local machine, or setup your own instance for private use or for your organization.

1. Install dependencies

asciinema.org site is a Ruby on Rails application. You need to have following dependencies installed:

  • Ruby 2.0+ (Ruby 2.1 is recommended)

  • bundler gem
    gem install bundler

  • PostgreSQL 8+ with libpq development headers
    sudo apt-get install postgresql libpq-dev on Debian/Ubuntu

  • libtsm
    See here for installation instructions. If you don't install it now the setup script (point 4 below) will try to install it for you anyway.

  • phantomjs 2.0+
    sudo add-apt-repository ppa:tanguy-patte/phantomjs && sudo apt-get update && sudo apt-get install phantomjs

2. Get the source code

Clone git repository:

$ git clone git://github.com/asciinema/asciinema.org.git
$ cd asciinema.org

3. Prepare database config file

Copy config/database.yml.example to config/database.yml. Then set database/user/password to whatever you prefer.

If database specified in database.yml doesn't exist then the following setup task will create it (make sure database user is allowed to create new databases).

4. Setup the app

Following script will install gem dependencies and setup database:

$ ./script/setup

5. Run Rails server

$ bundle exec rails server

6. Run the background job processor

The background job processor is needed for asciicast pre-processing and thumbnail generation.

$ bundle exec sidekiq

Contributing

If you want to contribute to this project check out Contributing page.

Authors

Developed with passion by Marcin Kulik and great open source contributors

Copyright © 2011-2015 Marcin Kulik. See LICENSE.txt for details.