eduar2 / octopush

Open Source Octopush project

Octopush

Unit tests:

Acceptance tests:

Octopush is an application to manage deployment requests executed by Jenkins.

You can check out our running demo here and play arround with its Jenkins

Installation

Octopush is built on PHP and MySQL. Its PHP dependencies are managed with composer but there are some components that should be installed manually:

• PHP 5.3
• php5-mysql
• MySQL
• HttpRequest PHP Library (pecl_http)
• phpunit

Quickstart

After intalling the base components mentioned above, you can follow the steps below to get your Octopush instance running:

• Clone repo
• Get the composer installer by executing: curl -s https://getcomposer.org/installer | php
• Install dependencies: php composer.phar install
• Create database using the script /sqls/schema.sql: mysql < schema.sql
• Adjust dabatase and RM Jenkins settings in src/config
• Run tests by executing phpunit
• Adjust Apache configuration based on the snippet below
• Adjust hosts file to add octopush.com entry
• Create log file:

    mkdir src/logs
    touch src/logs/octopush.log
    chmod 777 src/logs/octopush.log
    

• Browse the application at demo.octopush.com

Apache configuration

<VirtualHost *:80>
    ServerName  octopush.com
    ServerAlias demo.octopush.com

    DocumentRoot "/var/www/octopush/"

    <Directory "/var/www/octopush">
        Options -MultiViews
    AllowOverride None
        RewriteEngine On
        #RewriteBase /path/to/app
        RewriteCond %{REQUEST_FILENAME} !-f
        RewriteRule ^ index.php [L]
    </Directory>

    ErrorLog            /var/log/octopush/error_log
    CustomLog           /var/log/octopush/access_log combined
</VirtualHost>

Octopush API

In the folder sample_scripts you can find some scripts that will show you how to interact with Octopush API.

More Doc

http://olx-inc.github.io/octopush