This installation guide was created for and tested on Ubuntu 12.10. Please read doc/install/requirements.md for hardware and OS requirements.
This guide sets up a production server running Coinpunk. The basic procedure includes:
- Installing packages
- Installing, configuring and starting bitcoind
- Installing Coinpunk
- Installing and configuring the SQL database
- Installing Ruby Gems
- Configuring Nginx
First, update your package list. If your sudo is not present, you should run the update commands as root, and then run apt-get install sudo:
sudo apt-get update
sudo apt-get upgrade
Now you will need to install the necessary packages:
sudo apt-get install redis-server ntp build-essential zlib1g-dev libyaml-dev libssl-dev libgdbm-dev libreadline-dev libncurses5-dev libffi-dev git-core checkinstall libxml2-dev libxslt-dev libcurl4-openssl-dev libicu-dev software-properties-common python-software-properties
Now, you need to install Ruby. There are two ways to do this. The first way is to install ruby using the package system:
sudo apt-get install ruby ruby-dev
If you would rather compile ruby from source, download the latest version of ruby and install from source:
gzip -dc ruby-2.0.0-p195.tar.gz | tar xvf -w
cd ruby-2.0.0-p195
./configure
make
sudo make install
Now you will need to install bundler, which will download and compile the needed dependencies:
sudo gem install bundler
You can install bitcoind from the bitcoin package repository:
sudo add-apt-repository ppa:bitcoin/bitcoin
sudo aptitude update
sudo aptitude install bitcoind
Now you will need to create a .bitcoin folder to store your data and config for bitcoind:
mkdir ~/.bitcoin
Create a bitcoin.conf file, and add the following values:
echo "gen=0" > ~/.bitcoin/bitcoin.conf
echo "rpcuser=YOURRPCUSER" >> ~/.bitcoin/bitcoin.conf
echo "rpcpassword=YOURRPCPASS" >> ~/.bitcoin/bitcoin.conf
echo "maxconnections=3" >> ~/.bitcoin/bitcoin.conf
Start the bitcoind server:
bitcoind --daemon
Bitcoind will take several hours to catch up with the bitcoin network, so please be patient.
If you want bitcoind to run again, add this to /etc/rc.local:
/usr/bin/sudo -u YOURSHELLUSERNAME sh -c "/usr/bin/bitcoind -daemon"
We will have a bitcoind service file you can install coming soon.
Now you will need to clone Coinpunk and checkout the current version:
git clone https://github.com/kyledrake/coinpunk.git
cd coinpunk
git checkout 0.0.4
Copy the config.yml.template to config.yml:
cp config.yml.template config.yml
Now you will need to edit config.yml using vi, nano or a similar editor. Provide a random alpha-numeric value for session_secret, create a unique username and password for bitcoind_rpcuser and bitcoind_rpcpassword, and optionally add bitcoind_rpchost if you plan to access bitcoind from a different (non-localhost) server.
Your config.yml should look something this (with an optional development and test config if you're doing non-production work):
production:
database: 'sqlite://coinpunk.sqlite3'
session_secret: RANDOMSECRET
bitcoind_rpcuser: YOURRPCUSER
bitcoind_rpcpassword: YOURRPCPASS
If you don't have a preference for SQL databases, you can use SQLite, which will just store data in a file in the root of your application. The config.yml is configured this way by default. If you want to use PostgreSQL or MySQL, use postgres or mysql2 for the schema, respectively.
To install:
sudo apt-get install sqlite3 libsqlite3-dev
If you would like to use MySQL or PostgreSQL, simply change the database config to point to your database. For example, with PostgreSQL, you would use postgres://USER:PASS@localhost/coinpunk.
Now you will need to run bundle install to grab the required code. First, go to the coinpunk directory:
cd coinpunk
If you are just using Sqlite3 (default), run this:
sudo bundle install --without development test postgres mysql
If you are using PostgreSQL:
sudo apt-get install postgresql libpq-dev
sudo bundle install --without development test sqlite mysql
If you are using MySQL:
sudo bundle install --without development test sqlite postgres
In order to send e-mail notifications, you will need to have a mail server running on localhost. You can install Postfix with the command:
sudo apt-get install postfix
This will load a configuration screen. Choose Internet Site, and provide the site's (sub)domain name for the System mail name.
You can start Coinpunk with the following command:
./start
It starts on port 5678 by default, but you may want to set it to a specific port:
./start -p 10000
You can ensure this application gets started on system reboot by adding an entry to /etc/rc.local:
/usr/bin/sudo -u YOURSHELLUSERNAME sh -c "/home/YOURSHELLUSERNAME/coinpunk/start -p 10000"
We will eventually have a service file you can install. If you would like to contribute one, please let us know!
Instead of running this service directly on port 80, most people opt to use NGINX.
First, install Nginx:
sudo apt-get install nginx
sudo service nginx start
Now you need to add a new config file. Open /etc/nginx/sites-available/coinpunk with your favorite text editor and add the following:
upstream coinpunk {
server 127.0.0.1:10000;
}
server {
server_name coinpunk.kyledrake.net;
location / {
proxy_read_timeout 300;
proxy_connect_timeout 300;
proxy_redirect off;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_pass http://coinpunk;
}
}
Now symlink to sites-enabled, and reload nginx:
sudo ln -s /etc/nginx/sites-available/coinpunk /etc/nginx/sites-enabled/coinpunk
sudo service nginx reload
If you see an error like "could not build the server_names_hash", then go into your /etc/nginx/nginx.conf file and change server_names_hash_bucket_size to 64, and reload nginx.
This is an early install guide. It will become simpler eventually, and may have issues. If you run into any, please let us know so we can fix them (better yet, submit pull requests fixing them).