Dhorn: forgot to paste in the whole thing, whoops

2015-04-24T22:10:59Z

forgot to paste in the whole thing, whoops

← Older revision		Revision as of 22:10, 24 April 2015
Line 53:		Line 53:
	The following instructions were tested on an Mac OS X (10.9) machine but should work on any Linux machine as well.		The following instructions were tested on an Mac OS X (10.9) machine but should work on any Linux machine as well.

	First we will examine the Apache Config file <code>httpd.conf</code> typically located		First we will examine the Apache Config file <code>httpd.conf</code> typically located at:

			<code>/etc/apache2/httpd.conf</code>

			Make sure that the includes modual is present and active by searching for <code>mod_include</code> within the <code>httpd.conf</code> file, look for this line:

			<code>LoadModule include_module libexec/apache2/mod_include.so</code>

			Check that there isn’t a hash (#) in front of the above text (you’re text might differ slightly).

			==== Turn on Includes ====

			You’ll want to turn on the include option through your virtual host by adding:

			<code>Options +Includes</code>

			Here’s Drew’s vhost as an example:

			<pre><Virtualhost *:80>
			VirtualDocumentRoot "/Users/drew/www/%-2/"
			ServerName vhosts.localhost
			ServerAlias *.localhost
			ErrorLog "/var/log/apache2/vhosts.localhost-error_log"
			<Directory "/Users/drew/www/*">
			Options Indexes FollowSymLinks +Includes
			AllowOverride All
			Order allow,deny
			Allow from all
			</Directory>
			</Virtualhost></pre>
			''Side Note: Drew is using a nifty trick to automagically add folders in <code>/Users/drew/www/</code> to their virtual host, you can read more about that on [http://www.glenscott.co.uk/blog/simple-development-hosts-on-mac/ Glen Scott’s blog post Simple Development Hosts on Mac]''

			Pay attention to the line where <code>+Includes</code> has been added:

			<code>Options Indexes FollowSymLinks +Includes</code>

			Now we need to tell Apache to scan the proper files for includes. Typically, due to the extra server overhead, this is done only to files that are specified as having includes by using a special extension <code>.shtml</code> to indicate to the system that they should be scanned.

			The OmniCommons website uses <code>.html</code> throughout, so we simply need to tell our local apache server to scan all <code>.html</code> files for includes.

			Go back to your <code>httpd.conf</code> and find the line with <code>#AddOutputFilter INCLUDES .shtml</code> now add under that line:

			<code>AddOutputFilter INCLUDES .html</code>

			The hash (#) indicates that a line is commented out, because we want the config file to read our command we omit that hash. So this command is adding an output filter (<code>AddOutputFilter</code>) that applies Includes (<code>INCLUDES</code>) to all html files (<code>.html</code>).

			You should now be able to visit your virtual host, in Drew’s case it is <code>omnicommons.localhost</code>.

			'''Remember:''' The apache include will ''not'' run if you open the .html file directly in your browser, it must be served from the virtual host.

Dhorn: added information about how to edit the main website

2015-04-24T21:45:35Z

added information about how to edit the main website

New page

Omnicommons.org ([https://Omnicommons.org link]) is the main website for the Omni Commons.

== Development ==

The best way to add changes to the website is to fork the main repository ([https://github.com/omnicommons/omnicommons.org github.com/omnicommons/omnicommons.org]) then clone your fork to your local machine and test your changes locally before committing a pull request.

The following text will go over how to get the code on to your local machine and how to configure the machine to display the website, read on!

=== Fork, Clone, and Configure the Upstream ===

We assume you already know how to fork a github.com repository, if not please check out [https://help.github.com/articles/fork-a-repo/ github’s article on repo forking]

==== Clone the Repo ====

Once you have the repository forked you’ll want to clone it to your development machine using the clone command.

Here’s the command that github user dhornbein used:

<code>git clone git@github.com:dhornbein/omnicommons.org.git</code>

'''Note:''' This command will be different for you as <code>dhornbein</code> will be replaced by your github.com user name (or where ever you forked the repo)

==== Configure Remote Upstream ====

The “remote upstream” is a git remote repo that you pull from for the latest versions of the code. You will add the Omni Common’s omnicommons.org repository as the upstream remote location so you can perform <code>git pull upstream</code> to pull down any changes to the site since you forked it.

First we’ll add the upstream remote, you can copy and paste the line below:

<code>git remote add upstream git@github.com:omnicommons/omnicommons.org.git</code>

Now check that it worked by typing <code>git remote -v</code> to see all remote repos, it should look like this:

<pre>origin git@github.com:dhornbein/omnicommons.org.git (fetch)
origin git@github.com:dhornbein/omnicommons.org.git (push)
upstream git@github.com:omnicommons/omnicommons.org.git (fetch)
upstream git@github.com:omnicommons/omnicommons.org.git (push)</pre>
Basically this is saying that the '''origin''' of the files is at your (show as dhornbein’s) forked repo and the '''upstream''' destination is the Omni Common’s repo.

=== Setting up Server Side Includes on Localhost ===

The Omni Commons website uses Server Side Includes (SSI) to pull in head, nav, and footer html from the <code>/includes</code> folder. So we need to set up your local environment to handle this. Much of the following information is taken from [http://www.linuxtopia.org/HowToGuides/apache_ssi.html linuxtopia.org’s how to guide on apache ssi].

The SSI strings look like this:

<code></code>

Once SSI is enabled this line will be replaced by the content of <code>/includes/nav.html</code>. This allows us to edit the nav ''once'' and have those changes appear on all pages with the above snippet.

==== Enable mod_include ====

The first thing to do is ensure that your server has the mod_include module installed and enabled.

The following instructions were tested on an Mac OS X (10.9) machine but should work on any Linux machine as well.

First we will examine the Apache Config file <code>httpd.conf</code> typically located

Omnicommons.org - Revision history

Dhorn: forgot to paste in the whole thing, whoops

Dhorn: added information about how to edit the main website