Skip to content

Latest commit

 

History

History
109 lines (69 loc) · 3.74 KB

README.md

File metadata and controls

109 lines (69 loc) · 3.74 KB
Raw

ocf-v0.2

OCF Website v0.2. Based on Ruby on Rails.

Get Started

Requirements

  • You need to have Vagrant AND Virtual Box installed (see instructions here)

If you are contributor (of course more requirements ;) :

  • Make sure you put a valid SSH private key in provision/data/ as id_rsa. Valid means that it has authorisation into staging and/or production servers, and that its public key is added in your github SSH keys list. Here is an example command to do so:
cp ~/.ssh/id_rsa.pub provision/data/id_rsa

N.B.: See here for more instructions, especially if you need to create a ssh key. The public version of your ssh key shoud be sent to the main dev admin in order to add it to the servers (carefull, never share the private key!!!)

  • Also put into provision/data/ as gitconfig your .gitconfig file from your local environement that you have previously set up (guide here)
cp ~/.gitconfig provision/data/gitconfig

Start-up your dev box with Vagrant

Run those commands in the github project folder you just cloned:

# Start your box: it download the required files (can take some times), run the VM and configure the whole environement (this can also take some times, go grab a coffee and enjoy the feeling of seeing the computer doing stuff for you :)
vagrant up
# You then only have to run this command to ssh in a the perfect env!
vagrant ssh

Initialization

Initiate and prepopulate the database by running:

rake db:create db:migrate db:seed

Troubleshoot: 'Peer authentication failed' after rake:db

Happens when trying to act on the DB (drop/create/migrate/seed) from local Unix socket. By config postgres expects the postgres user to be the same as the Unix user ('peer'). Since the default postgres user is 'postgres' and the Unix user will be 'vagrant' there is a conflict.

Solution:

sudo nano /etc/postgresql/9.3/main/pg_hba.conf

In the file change every instance of 'peer' to 'trust' (any user can access) or 'md5' (users are password-protected but then you have to create a password for your user)

Save, then restart psql

sudo service postgresql restart

Test

To test the app, run the following commands:

rake test

Deployment

Push to staging

Simply run this command:

bundle exec cap staging deploy

N.B.: If it shows errors (unsuccessfull), make sure the command bundle exec cap staging check_write_permissions and bundle exec cap staging git:check runs successfully.

If not, it might comes from your ssh key in the provision/data folder that is either missing, or not authorized on the server.

Push to production

SOON

Create a production server

We choosed to run the servers on Digital ocean droplets. Here is a tutorial to get a instance up and running thanks to Passenger, along with installing rails.

Tutorial misses a point to first install passenger gem before running the installation command

To restart your server, just run sudo nginx -s reload.

N.B.: To connect easily to your instance with a command like ssh ocf, add [IP_ADDRESS] ocf to your file /etc/hosts and add those lines to ~/.ssh/config:

Host ocf
	HostName [IP_ADDRESS]
	User [USERNAME]
	Port [PORT]
	IdentityFile ~/.ssh/[name].pub

Knowing that you created the ssh-key and added thanks to ssh-add -K [name].pub.