Update readme

element
Marcin Kulik 9 years ago
parent 18ff4a0692
commit 0d49c12690

@ -9,34 +9,37 @@ 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](https://github.com/asciinema/asciinema)
This is the source code of asciinema.org website. You can find asciinema's
terminal recorder at
[asciinema/asciinema](https://github.com/asciinema/asciinema) and asciinema
player at
[asciinema/asciinema-player](https://github.com/asciinema/asciinema-player).
## Using Docker
## Setup instructions
### Using Docker
```bash
$ docker run -d -p 5432:5432 -e POSTGRES_PASSWORD=mypass --name=postgres postgres
$ docker run -d -p 6379:6379 --name=redis redis
$ docker run --rm -e DATABASE_URL="postgresql://postgres:mypass@172.17.42.1/asciinema" foobarto/asciinema.org bundle exec rake db:setup
$ docker run --rm -e DATABASE_URL="postgresql://postgres:mypass@172.17.42.1/asciinema" asciinema/asciinema.org bundle exec rake db:setup
# starting sidekiq using the provided start_sidekiq.rb file will also start sendmail service if you don't want to use SMTP
# otherwise start sidekiq by starting: bundle exec sidekiq
$ docker run -d -e DATABASE_URL="postgresql://postgres:mypass@172.17.42.1/asciinema" foobarto/asciinema.org ruby start_sidekiq.rb
$ docker run -d -e DATABASE_URL="postgresql://postgres:mypass@172.17.42.1/asciinema" -p 3000:3000 foobarto/asciinema.org
$ docker run -d -e DATABASE_URL="postgresql://postgres:mypass@172.17.42.1/asciinema" asciinema/asciinema.org ruby start_sidekiq.rb
$ docker run -d -e DATABASE_URL="postgresql://postgres:mypass@172.17.42.1/asciinema" -p 3000:3000 asciinema/asciinema.org
```
You can override the address/port that is sent in email with login token by passing HOST="host:port" environment variable when starting the web server.
Assuming you are running Docker Toolbox and VirtualBox: go to http://192.168.99.100:3000/ and enjoy.
## Manual Setup instructions
### Manual setup
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
#### 1. Install dependencies
asciinema.org site is a Ruby on Rails application. You need to have following
dependencies installed:
@ -57,7 +60,7 @@ dependencies installed:
* 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
#### 2. Get the source code
Clone git repository:
@ -66,7 +69,7 @@ $ git clone git://github.com/asciinema/asciinema.org.git
$ cd asciinema.org
```
### 3. Prepare database config file
#### 3. Prepare database config file
Copy *config/database.yml.example* to *config/database.yml*. Then set
database/user/password to whatever you prefer.
@ -75,7 +78,7 @@ 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
#### 4. Setup the app
Following script will install gem dependencies and setup database:
@ -83,13 +86,13 @@ Following script will install gem dependencies and setup database:
$ ./script/setup
```
### 5. Run Rails server
#### 5. Run Rails server
```bash
$ bundle exec rails server
```
### 6. Run the background job processor
#### 6. Run the background job processor
The background job processor is needed for asciicast pre-processing and
thumbnail generation.

Loading…
Cancel
Save