Skip to content

Commit

Permalink
Update in regard to 1.0.0-alpha.3
Browse files Browse the repository at this point in the history
  • Loading branch information
groganz committed Dec 10, 2014
1 parent d7d0822 commit 3c01026
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 603 deletions.
79 changes: 51 additions & 28 deletions administrator/installation/ce.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,48 @@
Community Edition (CE)
======================

The Community Edition has all relevant modules and sample data included so that you
can quickly try CampaignChain.
The 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
1. Set up Database
------------------

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

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

CampaignChain utilizes `Composer`_ for its package and modules management. Install
it with this command:

.. code-block:: bash
$ 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. Download CampaignChain
-------------------------

Download the Community Edition from `www.campaignchain.com/download`_.
Expand All @@ -27,26 +58,15 @@ Linux, you could issue this command:
... with ``www-data`` being the HTTP server's user and group, respectively.

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

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

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

CampaignChain utilizes `Composer`_ for its package and modules management. Install
it with this command:

.. code-block:: bash
5. Install Base System
----------------------

$ curl -sS https://getcomposer.org/installer | php
In the root of CampaignChain, execute composer to install all the packages
required by the base system.

4. Install Base System
----------------------
.. note::

In the root of CampaignChain, execute this command (not as root user!):
You must not execute below command as the root user on Linux.

.. code-block:: bash
Expand All @@ -55,7 +75,10 @@ In the root of CampaignChain, execute this command (not as root user!):
It will download and install all required packages and modules for the
CampaignChain base system. Please note that this might take a while.

At the end of the process, you will be asked in the command line to provide some
6. Configure Base System
------------------------

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 +92,12 @@ following (default values in brackets):
database_password (null):
java_path (/usr/bin/java):
5. Configure CampaignChain Scheduler
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 +106,13 @@ Use PHP's built-in Web server to run CampaignChain.
$ php app/console server:run
7. Installation Wizard
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 3c01026

Please sign in to comment.