From e513b11df8fa797e2cbdf95d97fd8bb9126b6669 Mon Sep 17 00:00:00 2001 From: David Thompson Date: Fri, 22 Aug 2014 10:57:58 -0400 Subject: [PATCH] Add README for 2015 site. --- 2015/README.md | 95 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 87 insertions(+), 8 deletions(-) diff --git a/2015/README.md b/2015/README.md index fcb5433a..28c624bc 100644 --- a/2015/README.md +++ b/2015/README.md @@ -1,20 +1,99 @@ LibrePlanet 2015 ================ +This is the static HTML site for LibrePlanet 2015. Read on for +instructions on how to setup your development environment. + Setting Up Apache ----------------- -* Enable server-side include module - ``` - a2enmod include - ``` +Apache is required in order to replicate the appearance of the website +on the live and staging servers. + +### Enable server-side include module + +``` +a2enmod include +``` + +### Create virtual host + +Create a new file in `/etc/apache2/sites-available` with the following contents: + +``` + + ServerName lp2015.libreplanet.org + DocumentRoot /path/to/libreplanet-static + + + Options FollowSymLinks + AllowOverride All + + + Options Indexes FollowSymLinks MultiViews + Options +Includes + XBitHack on + AllowOverride All + Order allow,deny + allow from all + + + ErrorLog ${APACHE_LOG_DIR}/error.log + LogLevel warn + CustomLog ${APACHE_LOG_DIR}/access.log combined + +``` + +Replace `/path/to/libreplanet-static` with the full path to your local +git repository. + +### Enable virtual host + +``` +a2ensite your-virtual-host +``` + +Replace `your-virtual-host` with the name of virtual host file you made. -* Create virtual host - *WRITEME* +### Restart Apache -Using Server-side Includes --------------------------- +``` +service apache2 restart +``` + +### Edit your hosts file + +Edit your system's `/etc/hosts` file and add the following to the bottom: + +``` +127.0.0.1 lp2015.libreplanet.org +``` + +### Test + +Visit in your web browser. If +everything is configured properly, you will see the LibrePlanet 2015 +site, complete with header, sidebar, and footer. + +Enabling Server Side Includes on New Pages +------------------------------------------ Files that contain include directives must be marked as executable otherwise Apache will not parse them. The directive `XBitHack on` enables this behavior. + +To mark a file as executable, run: + +``` +chmod +x foo.html +``` + +Replace `foo.html` with the desired file name. + +Deploying to Staging/Live Servers +--------------------------------- + +A system of git hooks automates deployment to the staging and live +servers. When you push to the `master` branch, the site is deployed +to the staging server. When you push to the `stable` branch, the site +is deployed to . -- 2.25.1