Create gh-pages branch via GitHuborigin/gh-pages

2 files changed, 30 insertions, 21 deletions

diff --git a/index.html b/index.html
index 4727dae..937febc 100644
--- a/index.html
+++ b/index.html
@@ -37,26 +37,16 @@
 <a id="getting-started" class="anchor" href="#getting-started" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Getting started</h1>
 
 <h2>
-<a id="dependencies" class="anchor" href="#dependencies" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Dependencies</h2>
-
-<ul>
-<li>Git (tested on version 2.5.0)</li>
-<li>Python (tested on version 2.7)</li>
-</ul>
-
-<h2>
 <a id="install-from-repository-recommended" class="anchor" href="#install-from-repository-recommended" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Install from repository (recommended)</h2>
 
-<h3>
-<a id="download-and-install" class="anchor" href="#download-and-install" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Download and install</h3>
+<p>When installing <code>Git-Auto-Deploy</code> from the repository, you'll need to make sure that Python (tested on version 2.7) and Git (tested on version 2.5.0) is installed on your system.</p>
+
+<p>Clone the repository and go into the repository root</p>
 
 <pre><code>git clone https://github.com/olipo186/Git-Auto-Deploy.git
 cd Git-Auto-Deploy
 </code></pre>
 
-<h3>
-<a id="configuration" class="anchor" href="#configuration" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Configuration</h3>
-
 <p>Make a copy of the sample configuration file and modify it to match your project setup. <a href="./docs/Configuration.md">Read more about the configuration options</a>.</p>
 
 <pre><code>cp config.json.sample config.json
@@ -64,18 +54,12 @@ cd Git-Auto-Deploy
 
 <p><em>Tip:</em> Make sure that the path specified in <code>pidfilepath</code> is writable for the user running the script, as well as any other path configured for your repositories.</p>
 
-<h3>
-<a id="running-the-application" class="anchor" href="#running-the-application" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Running the application</h3>
-
 <p>Run the application my invoking <code>python</code> and referencing the <code>gitautodeploy</code> module (the directory <code>Git-Auto-Deploy/gitautodeploy</code>).</p>
 
 <pre><code>python gitautodeploy
 </code></pre>
 
-<h3>
-<a id="start-automatically-on-boot" class="anchor" href="#start-automatically-on-boot" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Start automatically on boot</h3>
-
-<p>The easiest way to configure your system to automatically start <code>Git-Auto-Deploy</code> after a reboot is using crontab. Open crontab in edit mode using <code>crontab -e</code> and add the entry below.</p>
+<p>To start <code>Git-Auto-Deploy</code> automatically after a reboot, you can use crontab. Open crontab in edit mode using <code>crontab -e</code> and add the entry below.</p>
 
 <pre><code>@reboot /usr/bin/python /path/to/Git-Auto-Deploy/gitautodeploy --daemon-mode --quiet --config /path/to/git-auto-deploy.conf.json
 </code></pre>
@@ -83,6 +67,31 @@ cd Git-Auto-Deploy
 <p><em>Tip:</em> You can also configure <code>Git-Auto-Deploy</code> to start automatically using a init.d-script (for Debian and Sys-V like init systems) or a service for systemd. <a href="./docs/Start%20automatically%20on%20boot.md">Read more about starting Git-Auto-Deploy automatically using init.d or systemd</a>.</p>
 
 <h2>
+<a id="install-from-ppa-recommended-for-debian-systems" class="anchor" href="#install-from-ppa-recommended-for-debian-systems" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Install from PPA (recommended for debian systems)</h2>
+
+<p>Add our PPA repository</p>
+
+<pre><code>sudo add-apt-repository ppa:olipo186/git-auto-deploy
+sudo apt-get update
+</code></pre>
+
+<p>Install <code>Git-Auto-Deploy</code> using apt</p>
+
+<pre><code>sudo apt-get install git-auto-deploy
+</code></pre>
+
+<p>Modify the configuration file to match your project setup. <a href="./docs/Configuration.md">Read more about the configuration options</a>.</p>
+
+<pre><code>nano /etc/git-auto-deploy.conf.json
+</code></pre>
+
+<p>Start <code>Git-Auto-Deploy</code> and check it's status</p>
+
+<pre><code>service git-auto-deploy start
+service git-auto-deploy status
+</code></pre>
+
+<h2>
 <a id="alternative-installation-methods" class="anchor" href="#alternative-installation-methods" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Alternative installation methods</h2>
 
 <ul>
diff --git a/params.json b/params.json
index 601a43a..ce0d16a 100644
--- a/params.json
+++ b/params.json
@@ -1,7 +1,7 @@
 {
   "name": "Git-Auto-Deploy",
   "tagline": "Deploy your GitHub, GitLab or Bitbucket projects automatically on Git push events or webhooks using this small HTTP server written in Python. Continuous deployment in it's most simple form.",
-  "body": "# What is it?\r\n\r\nGit-Auto-Deploy consists of a small HTTP server that listens for Web hook requests sent from GitHub, GitLab or Bitbucket servers. This application allows you to continuously and automatically deploy you projects each time you push new commits to your repository.</p>\r\n\r\n![workflow](https://cloud.githubusercontent.com/assets/1056476/9344294/d3bc32a4-4607-11e5-9a44-5cd9b22e61d9.png)\r\n\r\n# How does it work?\r\n\r\nWhen commits are pushed to your Git repository, the Git server will notify ```Git-Auto-Deploy``` by sending a HTTP POST request with a JSON body to a pre configured URL (your-host:8001). The JSON body contains detailed information about the repository and what event that triggered the request. ```Git-Auto-Deploy``` parses and validates the request, and if all goes well it issues a ```git pull```.\r\n\r\nAdditionally, ```Git-Auto-Deploy``` can be configured to execute a shell command upon each successful ```git pull```, which can be used to trigger custom build actions or test scripts.</p>\r\n\r\n# Getting started\r\n\r\n## Dependencies\r\n* Git (tested on version 2.5.0)\r\n* Python (tested on version 2.7)\r\n\r\n## Install from repository (recommended)\r\n\r\n### Download and install\r\n\r\n    git clone https://github.com/olipo186/Git-Auto-Deploy.git\r\n    cd Git-Auto-Deploy\r\n\r\n### Configuration\r\n\r\nMake a copy of the sample configuration file and modify it to match your project setup. [Read more about the configuration options](./docs/Configuration.md).\r\n\r\n    cp config.json.sample config.json\r\n\r\n*Tip:* Make sure that the path specified in ```pidfilepath``` is writable for the user running the script, as well as any other path configured for your repositories.\r\n\r\n### Running the application\r\n\r\nRun the application my invoking ```python``` and referencing the ```gitautodeploy``` module (the directory ```Git-Auto-Deploy/gitautodeploy```).\r\n\r\n    python gitautodeploy\r\n\r\n### Start automatically on boot\r\n\r\nThe easiest way to configure your system to automatically start ```Git-Auto-Deploy``` after a reboot is using crontab. Open crontab in edit mode using ```crontab -e``` and add the entry below.\r\n\r\n    @reboot /usr/bin/python /path/to/Git-Auto-Deploy/gitautodeploy --daemon-mode --quiet --config /path/to/git-auto-deploy.conf.json\r\n\r\n*Tip:* You can also configure ```Git-Auto-Deploy``` to start automatically using a init.d-script (for Debian and Sys-V like init systems) or a service for systemd. [Read more about starting Git-Auto-Deploy automatically using init.d or systemd](./docs/Start automatically on boot.md).\r\n\r\n## Alternative installation methods\r\n\r\n* [Install as a python module (experimental)](./docs/Install as a python module.md)\r\n* [Install as a debian package (experimental)](./docs/Install as a debian package.md)\r\n* [Start automatically on boot (init.d and systemd)](./docs/Start automatically on boot.md)\r\n\r\n## Command line options\r\n\r\nBelow is a summarized list of the most common command line options. For a full list of available command line options, invoke the application with the argument ```--help``` or read the documentation article about [all avaialble command line options, environment variables and config attributes](./docs/Configuration.md).\r\n\r\nCommand line option    | Environment variable | Config attribute | Description\r\n---------------------- | -------------------- | ---------------- | --------------------------\r\n--daemon-mode (-d)     | GAD_DAEMON_MODE      |                  | Run in background (daemon mode)\r\n--quiet (-q)           | GAD_QUIET            |                  | Supress console output\r\n--config (-c) <path>   | GAD_CONFIG           |                  | Custom configuration file\r\n--pid-file <path>      | GAD_PID_FILE         | pidfilepath      | Specify a custom pid file\r\n--log-file <path>      | GAD_LOG_FILE         | logfilepath      | Specify a log file\r\n--host <host>          | GAD_HOST             | host             | Address to bind to\r\n--port <port>          | GAD_PORT             | port             | Port to bind to\r\n\r\n## Getting webhooks from git\r\nTo make your git provider send notifications to ```Git-Auto-Deploy``` you will need to provide the hostname and port for your ```Git-Auto-Deploy``` instance. Instructions for the most common git providers is listed below.\r\n\r\n**GitHub**\r\n1. Go to your repository -> Settings -> Webhooks and Services -> Add webhook</li>\r\n2. In \"Payload URL\", enter your hostname and port (your-host:8001)\r\n3. Hit \"Add webhook\"\r\n\r\n**GitLab**\r\n1. Go to your repository -> Settings -> Web hooks\r\n2. In \"URL\", enter your hostname and port (your-host:8001)\r\n3. Hit \"Add Web Hook\"\r\n\r\n**Bitbucket**\r\n1. Go to your repository -> Settings -> Webhooks -> Add webhook\r\n2. In \"URL\", enter your hostname and port (your-host:8001)\r\n3. Hit \"Save\"\r\n\r\n# More documentation\r\n\r\n[Have a look in the *docs* directory](./docs), where you'll find more detailed documentation on configurations, alternative installation methods and example workflows.\r\n",
+  "body": "# What is it?\r\n\r\nGit-Auto-Deploy consists of a small HTTP server that listens for Web hook requests sent from GitHub, GitLab or Bitbucket servers. This application allows you to continuously and automatically deploy you projects each time you push new commits to your repository.</p>\r\n\r\n![workflow](https://cloud.githubusercontent.com/assets/1056476/9344294/d3bc32a4-4607-11e5-9a44-5cd9b22e61d9.png)\r\n\r\n# How does it work?\r\n\r\nWhen commits are pushed to your Git repository, the Git server will notify ```Git-Auto-Deploy``` by sending a HTTP POST request with a JSON body to a pre configured URL (your-host:8001). The JSON body contains detailed information about the repository and what event that triggered the request. ```Git-Auto-Deploy``` parses and validates the request, and if all goes well it issues a ```git pull```.\r\n\r\nAdditionally, ```Git-Auto-Deploy``` can be configured to execute a shell command upon each successful ```git pull```, which can be used to trigger custom build actions or test scripts.</p>\r\n\r\n# Getting started\r\n\r\n## Install from repository (recommended)\r\n\r\nWhen installing ```Git-Auto-Deploy``` from the repository, you'll need to make sure that Python (tested on version 2.7) and Git (tested on version 2.5.0) is installed on your system.\r\n\r\nClone the repository and go into the repository root\r\n\r\n    git clone https://github.com/olipo186/Git-Auto-Deploy.git\r\n    cd Git-Auto-Deploy\r\n\r\nMake a copy of the sample configuration file and modify it to match your project setup. [Read more about the configuration options](./docs/Configuration.md).\r\n\r\n    cp config.json.sample config.json\r\n\r\n*Tip:* Make sure that the path specified in ```pidfilepath``` is writable for the user running the script, as well as any other path configured for your repositories.\r\n\r\nRun the application my invoking ```python``` and referencing the ```gitautodeploy``` module (the directory ```Git-Auto-Deploy/gitautodeploy```).\r\n\r\n    python gitautodeploy\r\n\r\nTo start ```Git-Auto-Deploy``` automatically after a reboot, you can use crontab. Open crontab in edit mode using ```crontab -e``` and add the entry below.\r\n\r\n    @reboot /usr/bin/python /path/to/Git-Auto-Deploy/gitautodeploy --daemon-mode --quiet --config /path/to/git-auto-deploy.conf.json\r\n\r\n*Tip:* You can also configure ```Git-Auto-Deploy``` to start automatically using a init.d-script (for Debian and Sys-V like init systems) or a service for systemd. [Read more about starting Git-Auto-Deploy automatically using init.d or systemd](./docs/Start automatically on boot.md).\r\n\r\n## Install from PPA (recommended for debian systems)\r\n\r\nAdd our PPA repository\r\n\r\n    sudo add-apt-repository ppa:olipo186/git-auto-deploy\r\n    sudo apt-get update\r\n\r\nInstall ```Git-Auto-Deploy``` using apt\r\n\r\n    sudo apt-get install git-auto-deploy\r\n\r\nModify the configuration file to match your project setup. [Read more about the configuration options](./docs/Configuration.md).\r\n\r\n    nano /etc/git-auto-deploy.conf.json\r\n\r\nStart ```Git-Auto-Deploy``` and check it's status\r\n\r\n    service git-auto-deploy start\r\n    service git-auto-deploy status\r\n\r\n## Alternative installation methods\r\n\r\n* [Install as a python module (experimental)](./docs/Install as a python module.md)\r\n* [Install as a debian package (experimental)](./docs/Install as a debian package.md)\r\n* [Start automatically on boot (init.d and systemd)](./docs/Start automatically on boot.md)\r\n\r\n## Command line options\r\n\r\nBelow is a summarized list of the most common command line options. For a full list of available command line options, invoke the application with the argument ```--help``` or read the documentation article about [all avaialble command line options, environment variables and config attributes](./docs/Configuration.md).\r\n\r\nCommand line option    | Environment variable | Config attribute | Description\r\n---------------------- | -------------------- | ---------------- | --------------------------\r\n--daemon-mode (-d)     | GAD_DAEMON_MODE      |                  | Run in background (daemon mode)\r\n--quiet (-q)           | GAD_QUIET            |                  | Supress console output\r\n--config (-c) <path>   | GAD_CONFIG           |                  | Custom configuration file\r\n--pid-file <path>      | GAD_PID_FILE         | pidfilepath      | Specify a custom pid file\r\n--log-file <path>      | GAD_LOG_FILE         | logfilepath      | Specify a log file\r\n--host <host>          | GAD_HOST             | host             | Address to bind to\r\n--port <port>          | GAD_PORT             | port             | Port to bind to\r\n\r\n## Getting webhooks from git\r\nTo make your git provider send notifications to ```Git-Auto-Deploy``` you will need to provide the hostname and port for your ```Git-Auto-Deploy``` instance. Instructions for the most common git providers is listed below.\r\n\r\n**GitHub**\r\n1. Go to your repository -> Settings -> Webhooks and Services -> Add webhook</li>\r\n2. In \"Payload URL\", enter your hostname and port (your-host:8001)\r\n3. Hit \"Add webhook\"\r\n\r\n**GitLab**\r\n1. Go to your repository -> Settings -> Web hooks\r\n2. In \"URL\", enter your hostname and port (your-host:8001)\r\n3. Hit \"Add Web Hook\"\r\n\r\n**Bitbucket**\r\n1. Go to your repository -> Settings -> Webhooks -> Add webhook\r\n2. In \"URL\", enter your hostname and port (your-host:8001)\r\n3. Hit \"Save\"\r\n\r\n# More documentation\r\n\r\n[Have a look in the *docs* directory](./docs), where you'll find more detailed documentation on configurations, alternative installation methods and example workflows.\r\n",
   "google": "",
   "note": "Don't delete this file! It's used internally to help with page regeneration."
 }
\ No newline at end of file