Extract installation instructions into separate doc

install-doc
Marcin Kulik 7 years ago
parent e12f100018
commit 43d19f3ad3

@ -15,93 +15,22 @@ at [asciinema/asciinema](https://github.com/asciinema/asciinema), and the source
code of asciinema web player
at [asciinema/asciinema-player](https://github.com/asciinema/asciinema-player).
## Setup instructions
## Setting up your own asciinema web app instance
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.
asciinema terminal recorder uses [asciinema.org](https://asciinema.org) as its
default host for the recordings. It's free, public service (all uploaded
recordings are __private by default__ though).
### Quickstart Using Docker Compose
If you're not comfortable with uploading your terminal sessions to
asciinema.org, or your company's policy prevents you from doing that, you can
set up your own instance for private use. See
our [asciinema web app install guide](docs/INSTALL.md).
Required:
Once you have your instance running, point asciinema recorder to it by setting
API URL in `~/.config/asciinema/config` file as follows:
- [Docker](https://docs.docker.com/engine/getstarted/step_one/#step-1-get-docker)
- [docker-compose 1.5+](https://docs.docker.com/compose/install/)
```bash
$ wget https://raw.githubusercontent.com/asciinema/asciinema.org/master/docker-compose.yml
$ docker-compose run --rm db_init
$ docker-compose up -d web
```
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://your-docker-host:3000/ and enjoy.
### Manual setup
#### 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
* asciinema's libtsm fork (`asciinema` branch)
See [here](https://github.com/asciinema/libtsm/blob/asciinema/README) 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:
```bash
$ 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:
```bash
$ ./script/setup
```
#### 5. Run Rails server
```bash
$ bundle exec rails server
```
#### 6. Run the background job processor
The background job processor is needed for asciicast pre-processing and
thumbnail generation.
```bash
$ bundle exec sidekiq
```
[api]
url = https://your.asciinema.host
## Contributing

@ -0,0 +1,91 @@
# asciinema web app install guide
## Quickstart Using Docker Compose
Required:
- [Docker](https://docs.docker.com/engine/getstarted/step_one/#step-1-get-docker)
- [docker-compose 1.5+](https://docs.docker.com/compose/install/)
```bash
$ wget https://raw.githubusercontent.com/asciinema/asciinema.org/master/docker-compose.yml
$ docker-compose run --rm db_init
$ docker-compose up -d web
```
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://your-docker-host:3000/ and enjoy.
## Manual setup
### 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
* asciinema's libtsm fork (`asciinema` branch)
See [here](https://github.com/asciinema/libtsm/blob/asciinema/README) 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:
```bash
$ 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:
```bash
$ ./script/setup
```
### 5. Run Rails server
```bash
$ bundle exec rails server
```
### 6. Run the background job processor
The background job processor is needed for asciicast pre-processing and
thumbnail generation.
```bash
$ bundle exec sidekiq
```
## Using asciinema recorder with your instance
Once you have your instance running, point asciinema recorder to it by setting
API URL in `~/.config/asciinema/config` file as follows:
[api]
url = https://your.asciinema.host
Loading…
Cancel
Save