Skip to content
This repository

Record and share your terminal session, the right way.

branch: master
Octocat-spinner-32 app Update a separate instance of current user April 12, 2014
Octocat-spinner-32 config Use Virtus coercion love in config object March 21, 2014
Octocat-spinner-32 db Rename nickname to username February 12, 2014
Octocat-spinner-32 doc Fresh Rails 3.1 app with DM 1.2 and RSpec 2.7 November 21, 2011
Octocat-spinner-32 lib Clean up test auth helpers March 16, 2014
Octocat-spinner-32 public Remove precompiled assets from public/ November 27, 2013
Octocat-spinner-32 script Run build with local persona js file March 22, 2014
Octocat-spinner-32 spec Update a separate instance of current user April 12, 2014
Octocat-spinner-32 src Create bin dir when compiling terminal binary September 21, 2013
Octocat-spinner-32 vendor Move glyphicons from vendor/assets/fonts to app/assets/fonts November 22, 2013
Octocat-spinner-32 .env.example Unicorn with girl_friday on Heroku June 09, 2012
Octocat-spinner-32 .gitignore Use flat config files December 09, 2013
Octocat-spinner-32 .rspec.example Example .rspec config file November 23, 2012
Octocat-spinner-32 .ruby-version Use ruby 2.1 in development January 27, 2014
Octocat-spinner-32 .travis.yml Don't build on ruby 2.0 anymore February 01, 2014
Octocat-spinner-32 Gemfile Upgrade rails and sass-rails gems April 12, 2014
Octocat-spinner-32 Gemfile.lock Upgrade rails and sass-rails gems April 12, 2014
Octocat-spinner-32 Guardfile Clean up test auth helpers March 16, 2014
Octocat-spinner-32 LICENSE Change license to AGPL v3 April 04, 2014
Octocat-spinner-32 Procfile Make foreman start sidekiq with proper config file path September 14, 2013
Octocat-spinner-32 README.md Add coveralls badge to readme February 01, 2014
Octocat-spinner-32 Rakefile Change all occurrences of old project name to the new one September 23, 2013
Octocat-spinner-32 config.ru Load unicorn worker killer only in production January 29, 2014
Octocat-spinner-32 sidekiq.ru Add rake task for starting sidekiq web panel September 14, 2013
README.md

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 the terminal sessions and sharing them on the web.

This is the source code of asciinema.org (formerly ascii.io) website and JS player. If you're looking for asciinema terminal recorder go here: sickill/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 your organization.

1. Install dependencies

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

  • Ruby 1.9.3+ (Ruby 2.0.0-p247 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.

2. Get the source code

Clone git repository:

$ git clone git://github.com/sickill/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 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

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

Something went wrong with that request. Please try again.