Skip to content

Commit

Permalink
Merge tag '1.0.0-alpha.4'
Browse files Browse the repository at this point in the history
  • Loading branch information
groganz committed Jan 19, 2015
2 parents 8443680 + 95911b7 commit 6e5cd64
Show file tree
Hide file tree
Showing 8 changed files with 176 additions and 608 deletions.
87 changes: 55 additions & 32 deletions administrator/installation/ce.rst
Original file line number Diff line number Diff line change
@@ -1,39 +1,23 @@
Community Edition (CE)
======================

The Community Edition has all relevant modules and sample data included so that you
can quickly try CampaignChain.
The CampaignChain Community Edition has all basic modules included and you can
easily add more of them inside the application.

0. Preparation
---------------
--------------

1. Verify that your system meets the :doc:`minimum system requirements <../requirements>`
to run CampaignChain.
2. Ensure that your MySQL server is running.

1. Download CampaignChain
-------------------------

Download the Community Edition from `www.campaignchain.com/download`_.

Extract the contents of the archive to a directory on your system.

Make sure that PHP has access to all files in the CampaignChain directory. On
Linux, you could issue this command:

.. code-block:: bash
$ chown -R www-data:www-data /path/to/campaignchain
... with ``www-data`` being the HTTP server's user and group, respectively.

2. Set up Database
1. Set up Database
------------------

Launch your MySQL client of choice and create a new MySQL database for the
application.

3. Install Composer
2. Install Composer
-------------------

CampaignChain utilizes `Composer`_ for its package and modules management. Install
Expand All @@ -43,19 +27,35 @@ it with this command:
$ curl -sS https://getcomposer.org/installer | php
3. Install Bower
----------------

For JavaScript components, CampaignChain makes use of Bower, which - you guessed
it - is a package manager for JavaScript code.

Before you can install Bower, you must first `install npm`_ which ships with
node.js.

Now install Bower through npm:

.. code-block:: bash
$ npm install -g bower
4. Install Base System
----------------------

In the root of CampaignChain, execute this command (not as root user!):
In a folder of your choice, execute Composer to download all files of the
CampaignChain base system. Please note that this might take a while.

.. code-block:: bash
$ composer install
$ composer create-project campaignchain/campaignchain-ce campaignchain 1.0.0-alpha.4
It will download and install all required packages and modules for the
CampaignChain base system. Please note that this might take a while.
5. Configure Base System
------------------------

At the end of the process, you will be asked in the command line to provide some
During the process, Composer will ask in the command line to provide some
configuration parameters. Please make sure you check/provide at least the
following (default values in brackets):

Expand All @@ -69,13 +69,26 @@ following (default values in brackets):
database_password (null):
java_path (/usr/bin/java):
6. Clear Cache and Dump Assets
------------------------------

Once Composer is done, execute the following commands, still inside the
CampaignChain root folder:

.. code-block:: bash
$ php app/console cache:clear --env=prod --no-debug
.. code-block:: bash
5. Configure CampaignChain Scheduler
$ php app/console assetic:dump --env=prod --no-debug
7. Configure CampaignChain Scheduler
------------------------------------

.. include:: ../include/_configure_scheduler.rst.inc

6. Start Server
8. Start Server
---------------

Use PHP's built-in Web server to run CampaignChain.
Expand All @@ -84,13 +97,22 @@ Use PHP's built-in Web server to run CampaignChain.
$ php app/console server:run
7. Installation Wizard
----------------------
By default, the built-in Web server listens for connections on 127.0.0.1. If
you're planning to connect to the server over a network, you can specify the
network IP address that the server should use. For example, the command below
runs the Web server on port 80 of IP address 192.168.1.1:

.. code-block:: bash
$ php app/console server:run 192.168.1.1:80
9. Installation Wizard
-----------------------

Hop over to http://localhost:8000/campaignchain/install.php and follow the instructions.

8. Install Modules
------------------
10. Install Modules
-------------------

You can easily add modules (e.g. to post on Twitter or Facebook) at http://localhost:8000/modules/new/.

Expand All @@ -104,5 +126,6 @@ To make full use of CampaignChain's capabilities, you could now
1. :doc:`Configure Call to Action (CTA) tracking <../configuration/cta>`
2. :doc:`Learn how to create your first campaign and activity </user/get_started>`

.. _install npm: http://nodejs.org/download/
.. _www.campaignchain.com/download: http://www.campaignchain.com/download
.. _Composer: https://getcomposer.org/download/

0 comments on commit 6e5cd64

Please sign in to comment.