asciinema hosting web app

Go to file

Marcin Kulik 402529c60e Fix 404 handling on docs pages		2014-07-05 20:16:57 +02:00
app	Fix 404 handling on docs pages	2014-07-05 20:16:57 +02:00
config	Introduce admin	2014-07-05 14:59:42 +02:00
db	Add theme changing for whole user profile and single asciicast	2014-07-01 21:33:50 +02:00
doc
lib	Clean up test auth helpers	2014-03-16 16:03:33 +01:00
public	Remove precompiled assets from public/	2013-11-27 23:38:15 +01:00
script	Add missing sudo to cibuild script	2014-06-25 10:08:36 +02:00
spec	Introduce admin	2014-07-05 14:59:42 +02:00
src	Create bin dir when compiling terminal binary	2013-09-21 13:42:52 +02:00
vendor	Upgrade player	2014-07-02 17:31:58 +02:00
.env.example
.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 build on ruby 2.0 anymore	2014-02-01 10:39:42 +01:00
config.ru	Load unicorn worker killer only in production	2014-01-29 16:00:24 +01:00
Gemfile	Introduce admin	2014-07-05 14:59:42 +02:00
Gemfile.lock	Introduce admin	2014-07-05 14:59:42 +02:00
Guardfile	Clean up test auth helpers	2014-03-16 16:03:33 +01: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	Change all occurrences of old project name to the new one	2013-09-23 19:05:36 +02:00
README.md	Add coveralls badge to readme	2014-02-01 11:13:37 +01: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 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