asciinema hosting web app

Go to file

Marcin Kulik 2857ba303e Add docs on config file		2015-05-25 18:30:39 +00:00
app	Add docs on config file	2015-05-25 18:30:39 +00:00
bin	Refactor PNG generation	2015-03-29 14:15:05 +00:00
config	Make all assets on S3 private by default	2015-04-27 08:08:46 +00:00
db	Make all asciicasts private by default	2015-05-10 16:46:25 +00:00
lib	Use warden scopes	2015-04-04 17:46:55 +00:00
public	Improved left/right margin for guru meditation	2014-10-25 21:19:28 +02:00
script	Install libtsm from "libtsm-3" tag	2015-05-15 18:09:02 +02:00
spec	Use policy scope to decide which asciicasts should be listed	2015-05-15 19:13:37 +00:00
src	Update terminal.c to work with latest libtsm	2015-05-14 15:02:25 -04:00
vendor	There's no real need for Backbone here	2015-05-13 10:39:03 +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	Don't test on rbx nor jruby	2015-04-27 13:22:41 +00:00
config.ru	Load unicorn worker killer only in production	2014-01-29 16:00:24 +01:00
Gemfile	Remove unused gems	2015-05-13 10:56:54 +00:00
Gemfile.lock	Remove unused gems	2015-05-13 10:56:54 +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

README.md

asciinema.org

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