Skip to content

Latest commit

 

History

History
241 lines (165 loc) · 5.46 KB

INSTALL.md

File metadata and controls

241 lines (165 loc) · 5.46 KB
Raw

Installing eegi Project

  1. Development
  2. Production

Development

Code

git clone https://github.com/katur/eegi.git
cd eegi/eegi
# add localsettings.py; set DEBUG=True

Database

Add dev database connection info to eegi/localsettings.py. This might be a dev database that already exists on another machine, or a new database on your own machine. You might import an existing dump, or you might generate an empty database from scratch with ./manage.py migrate. Do whatever suits your needs.

Python Dependencies

Python version is listed in runtime.txt.

Python package dependencies, including Django, are listed in requirements.txt. These should be pip-install into a fresh Python virtual environment. I use virtualenvwrapper to make working with Python virtual environments easier.

In a nutshell (assuming pip, virtualenv, and virtualenvwrapper installed):

mkvirtualenv eegi
workon eegi
pip install -r requirements.txt

# To deactivate virtual environment
deactivate

CSS/JavaScript Dependencies

To compile SASS to CSS:

sass --compile --style compressed website/static/stylesheets/styles.sass

Instead of compiling SASS directly, feel free to use the Gulp.js build script, which watches for changes in SASS files and automatically compiles.

To set up, assuming Gulp.js is installed on the system, run the following in the project root (which will install dependencies in a git-ignored directory called node_modules):

npm install --dev-save

And to start the gulp build script, run the following in the project root:

gulp

Running Django's Built-In Development Server

./manage.py runserver <IP address>:8000

Some Other Notes About Development

  • There is no need to collect static files in development. (When DEBUG=True, Django finds static files dynamically across the apps.)

Production

Here is a walkthrough of how I deployed this with Apache and modwsgi on Ubuntu.

This assumes that most sysadmin setup is already complete. This sysadmin steps includes the following:

  • installing Python and virtualenv
  • installing Apache and modwsgi
  • installing git
  • installing MySQL
  • creating a UNIX user for this project (named eegi)
  • creating the project directory at /opt/local/eegi, owned by eegi
  • creating a directory for data and backups at /volume/data1/project/eegi, owned by eegi
  • creating a MySQL database (eegi)
  • creating a MySQL read-write user (eegi) and a MySQL read-only user (eegi_ro)

Database

mysql -u eegi -p eegi < <sql dump filename>

Database Backups

mkdir /volume/data1/project/eegi/database_backups

mkdir /opt/local/eegi/secret
chmod 700 /opt/local/eegi/secret

touch /opt/local/eegi/secret/eegi.my.cnf
chmod 600 /opt/local/eegi/secret/eegi.my.cnf
vi /opt/local/eegi/secret/eegi.my.cnf
> [client]
> user = eegi_ro
> password = <password>

mkdir /opt/local/eegi/bin
chmod 775 /opt/local/eegi/bin

vi ~/.zshenv
> path=(/opt/local/eegi/bin $path)
source ~/.zshenv

touch /opt/local/eegi/bin/mysqldump_eegi
chmod 774 /opt/local/eegi/bin/mysqldump_eegi
vi /opt/local/eegi/bin/mysqldump_eegi
> #!/bin/sh
>
> /usr/bin/mysqldump --defaults-file=/opt/local/eegi/secret/eegi.my.cnf --single-transaction eegi | pbzip2 -c -p16 > /volume/data1/project/eegi/database_backups/eegi_`date +%Y-%m-%d_%H-%M-%S`.sql.bz2

crontab -e
> 0 4 * * 7 /opt/local/eegi/bin/mysqldump_eegi

Code

cd /opt/local/eegi
git clone https://github.com/katur/eegi.git

cd /opt/local/eegi/eegi/eegi
# add localsettings.py; make sure to set DEBUG=False

Dependencies

cd /opt/local/eegi
virtualenv --python=/usr/bin/python2.7 eegivirtualenv
# NOTE: This use of virtualenv hardcodes the name and location of the virtualenv dir.
# But the --relocatable arg has problems and is to be deprecated.
# So, to move or rename it, delete and recreate the virtualenv dir.

source /opt/local/eegi/eegivirtualenv/bin/activate
pip install -r /opt/local/eegi/eegi/requirements.txt

Static Files

source /opt/local/eegi/eegivirtualenv/bin/activate
cd /opt/local/eegi/eegi
./manage.py collectstatic

Apache Configuration

mkdir /opt/local/eegi/apache2

vi /opt/local/eegi/apache2/eegi.conf
# Add project-specific apache settings.
# Note that part of this configuration involves serving static files directly.
# Please see the above file, on pyxis, for details.

sudo ln -s /opt/local/eegi/apache2/eegi.conf /etc/apache2/sites-enabled/001-eegi.conf

sudo vi /etc/apache2/ports.conf
# Enable/add line to Listen 80

Apache Commands

sudo service apache2 restart
sudo service apache2 start
sudo service apache2 stop

Deploying Changes

As project user...

# Dump database and record the currently-deployed git commit,
# in case reverting is necessary

# Activate Python virtual environment
source /opt/local/eegi/eegivirtualenv/bin/activate

# Pull changes
cd /opt/local/eegi/eegi
git pull

# If changes to requirements.txt
pip install -r requirements.txt

# If new/changed static files
./manage.py collectstatic

# If new database migrations
./manage.py migrate

# If any scripts must be run
./manage.py scriptname

# If there are unit tests
./manage.py test

As user with sudo...

sudo service apache2 restart

If front-end changes, inspect visually.