Renamed LiveSupport to Campcaster, for ticket #1883
This commit is contained in:
parent
5124344b3c
commit
174f9798da
30 changed files with 399 additions and 400 deletions
|
@ -2,12 +2,12 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||
<title>Getting started with the LiveSupport development environment</title>
|
||||
<title>Getting started with the Campcaster development environment</title>
|
||||
<meta content="$Author$" name="author">
|
||||
</head>
|
||||
<body>
|
||||
<h1>Preface</h1>
|
||||
This document is part of the <a href="http://livesupport.campware.org/">LiveSupport</a>
|
||||
This document is part of the <a href="http://campcaster.campware.org/">Campcaster</a>
|
||||
project, Copyright © 2004 <a href="http://www.mdlf.org/">Media
|
||||
Development Loan Fund</a>, under the GNU <a
|
||||
href="http://www.gnu.org/licenses/gpl.html">GPL</a>.<br>
|
||||
|
@ -17,23 +17,23 @@ Development Loan Fund</a>, under the GNU <a
|
|||
<li>Location: $URL$</li>
|
||||
</ul>
|
||||
<h1>Scope</h1>
|
||||
This document describes how to set up the LiveSupport development
|
||||
This document describes how to set up the Campcaster development
|
||||
environment.<br>
|
||||
|
||||
<h1>Introduction</h1>
|
||||
LiveSupport uses a well-defined <a
|
||||
Campcaster uses a well-defined <a
|
||||
href="developmentEnvironment/index.html">development environment</a>.
|
||||
Most of the LiveSupport-specific files are included in the version
|
||||
Most of the Campcaster-specific files are included in the version
|
||||
control system, but some preparation and setup has to be made on system
|
||||
used to develop LiveSupport as well.<br>
|
||||
used to develop Campcaster as well.<br>
|
||||
<br>
|
||||
There is a simplified and Ubuntu-centric version of this document in the
|
||||
<a href="http://code.campware.org/projects/livesupport/wiki/DevelopmentEnvironment">
|
||||
LiveSupport Trac wiki</a>.
|
||||
<a href="http://code.campware.org/projects/campcaster/wiki/DevelopmentEnvironment">
|
||||
Campcaster Trac wiki</a>.
|
||||
|
||||
<h1>Steps<br>
|
||||
</h1>
|
||||
The following steps needed to be taken for setting up the LiveSupport
|
||||
The following steps needed to be taken for setting up the Campcaster
|
||||
development environment.<br>
|
||||
<ul>
|
||||
<li>install development tools<br>
|
||||
|
@ -42,25 +42,25 @@ development environment.<br>
|
|||
<li>check out the sources</li>
|
||||
<li>configure the environment<br>
|
||||
</li>
|
||||
<li>set up tools used by LiveSupport</li>
|
||||
<li>set up tools used by Campcaster</li>
|
||||
<li>personalize your development environment<br>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>Install development tools</h2>
|
||||
Install all the tools needed for the development of LiveSupport. Please
|
||||
Install all the tools needed for the development of Campcaster. Please
|
||||
see the <a href="developmentTools.html">development tools</a> document
|
||||
for a list of tools needed.<br>
|
||||
<h2>Set up additional system resources</h2>
|
||||
The LiveSupport development environment uses some system resources,
|
||||
The Campcaster development environment uses some system resources,
|
||||
that are not reasonable to include in the environment itself.<br>
|
||||
<h3>Test database<br>
|
||||
</h3>
|
||||
One such
|
||||
resource is an ODBC datasource to a test database. This
|
||||
database has to be accessible for executing the test suites and
|
||||
applications within the LiveSupport development environment.<br>
|
||||
applications within the Campcaster development environment.<br>
|
||||
<br>
|
||||
First, LiveSupport expects a <a href="http://www.postgresql.org/">PostgreSQL</a>
|
||||
First, Campcaster expects a <a href="http://www.postgresql.org/">PostgreSQL</a>
|
||||
database, and an ODBC
|
||||
Data Source accessible to it through <a href="http://www.unixodbc.org/">unixODBC</a>.
|
||||
Please refer to the documentation of these tools to set them up.<br>
|
||||
|
@ -77,7 +77,7 @@ are enabled by default. If you are using an older version, do the following:
|
|||
<br>
|
||||
<pre><code>tcpip_socket = true</code></pre>
|
||||
<br>
|
||||
<li> and also edit <code>pg_hba.conf</code> (usually
|
||||
<li> and also edit <code>pg_hba.conf</code> (usually
|
||||
<code>/var/lib/postgres/data/pg_hba.conf</code>)
|
||||
to include the following line, before other lines related to access
|
||||
through localhost:<br>
|
||||
|
@ -91,7 +91,7 @@ restart the postgresql daemon.<br>
|
|||
|
||||
<h3>Web server<br>
|
||||
</h3>
|
||||
Second, LiveSupport expects:
|
||||
Second, Campcaster expects:
|
||||
<ul>
|
||||
<li><a href="http://httpd.apache.org/">Apache</a> httpd server
|
||||
running on the development computer</li>
|
||||
|
@ -113,41 +113,41 @@ called <code>www-data</code>.
|
|||
|
||||
<h3>Apache configuration</h3>
|
||||
The storage server uses some directives which are not enabled by default.
|
||||
To enable them, find the configuration file for the userdir module of
|
||||
apache, and change the <code>AllowOverride</code> directive in the
|
||||
To enable them, find the configuration file for the userdir module of
|
||||
apache, and change the <code>AllowOverride</code> directive in the
|
||||
<code><Directory /home/*/public_html></code> section to <code>All</code>.
|
||||
<br><br>
|
||||
|
||||
<h2>Check out the sources</h2>
|
||||
The LiveSupport development directory tree can be accessed anonymously via
|
||||
The Campcaster development directory tree can be accessed anonymously via
|
||||
<a href="http://subversion.tigris.org/">Subversion</a>, at
|
||||
<code>svn+ssh://code.campware.org/home/svn/repo/livesupport/trunk/livesupport</code>.
|
||||
<code>svn+ssh://code.campware.org/home/svn/repo/campcaster/trunk/campcaster</code>.
|
||||
The following Subversion command
|
||||
would check out the development tree:<br><br>
|
||||
<pre><code>svn checkout svn+ssh://code.campware.org/home/svn/repo/livesupport/trunk/livesupport</code></pre><br>
|
||||
This will check out and create the LiveSupport development <a
|
||||
<pre><code>svn checkout svn+ssh://code.campware.org/home/svn/repo/campcaster/trunk/campcaster</code></pre><br>
|
||||
This will check out and create the Campcaster development <a
|
||||
href="developmentEnvironment/directoryStructure.html">directory
|
||||
structure</a>.<br>
|
||||
<br>
|
||||
|
||||
<h2>Configure the environment</h2>
|
||||
First, you need to create the database and ODBC data source used by
|
||||
LiveSupport. This is done most easily by running the script
|
||||
<code>livesupport/bin/user_setup_db.sh</code>.
|
||||
Run the scripts as root, and provide your user name with the
|
||||
Campcaster. This is done most easily by running the script
|
||||
<code>campcaster/bin/user_setup_db.sh</code>.
|
||||
Run the scripts as root, and provide your user name with the
|
||||
<code>--user</code> option:
|
||||
|
||||
<pre><code>
|
||||
cd livesupport
|
||||
cd campcaster
|
||||
sudo ./bin/user_setup_db.sh --user=<ls_developer_user>
|
||||
</code></pre>
|
||||
<br>
|
||||
The script will set up the following resources:<br>
|
||||
<ul>
|
||||
<li>a PostgreSQL user named <code>test</code> with the password
|
||||
<li>a PostgreSQL user named <code>test</code> with the password
|
||||
<code>test</code> (if it does not exist)</li>
|
||||
<li>a PostgreSQL database named
|
||||
<code>LiveSupport-<ls_developer_user></code></li>
|
||||
<li>a PostgreSQL database named
|
||||
<code>Campcaster-<ls_developer_user></code></li>
|
||||
<li>an ODBC data source of the same name, with user name
|
||||
and password <code>test</code></li>
|
||||
</li>
|
||||
|
@ -157,27 +157,27 @@ The script will set up the following resources:<br>
|
|||
Next (and last), you compile the code and set up the configuration files.
|
||||
Both are done by the script
|
||||
<pre><code>
|
||||
cd livesupport
|
||||
cd campcaster
|
||||
./bin/setupDevelopmentEnvironment.sh --apache-group=<apache_group>
|
||||
</code></pre>
|
||||
<br>
|
||||
This script will set up the libraries used by LiveSupport (by compiling
|
||||
and installing them under livesupport/usr), and set up the development
|
||||
environment for all LiveSupport modules.<br>
|
||||
This script will set up the libraries used by Campcaster (by compiling
|
||||
and installing them under campcaster/usr), and set up the development
|
||||
environment for all Campcaster modules.<br>
|
||||
<br>
|
||||
It will also create your personalized configuration files under
|
||||
<code>~/.livesupport</code>, make certain directories writable for Apache
|
||||
(this is where we need the current user to be a member of the
|
||||
<code>apache</code> group), define a user-specific port for the scheduler
|
||||
<code>~/.campcaster</code>, make certain directories writable for Apache
|
||||
(this is where we need the current user to be a member of the
|
||||
<code>apache</code> group), define a user-specific port for the scheduler
|
||||
daemon, and create a symlink in <code>~/public_html/</code> to the PHP
|
||||
entry points.<br>
|
||||
<br>
|
||||
After running the above script, the livesupport development environment
|
||||
After running the above script, the campcaster development environment
|
||||
for the current user will be unique on the system, and will not
|
||||
conflict with resources used by other developers. For example, the
|
||||
LiveSupport HTML user interface for the user will be reachable at:<br>
|
||||
Campcaster HTML user interface for the user will be reachable at:<br>
|
||||
<pre><code>
|
||||
http://localhost/~<ls_developer_user>/livesupport/htmlUI/var
|
||||
http://localhost/~<ls_developer_user>/campcaster/htmlUI/var
|
||||
</code></pre>
|
||||
<br>
|
||||
|
||||
|
@ -191,21 +191,21 @@ the commands in <code>setupDevelopmentEnvironment</code> up to, and not
|
|||
including, the call to <code>user_setup.sh</code>; and manually execute
|
||||
the "Setup storage server" and "Setup directory permissions" portions
|
||||
of the <code>user_setup.sh</code> script. Finally, create a symlink
|
||||
<code>livesupport</code> in the root data directory of the Apache server
|
||||
which points to <code>livesupport/src/modules/</code>.
|
||||
<code>campcaster</code> in the root data directory of the Apache server
|
||||
which points to <code>campcaster/src/modules/</code>.
|
||||
The address of the HTML interface will now be<br>
|
||||
<pre><code>
|
||||
http://localhost/livesupport/htmlUI/var
|
||||
http://localhost/campcaster/htmlUI/var
|
||||
</code></pre>
|
||||
<br>
|
||||
After this, the development environment should work, using the default
|
||||
configuration files. NOTE: this single-user method has not been used by any
|
||||
developers for quite some time, so these instructions may be
|
||||
developers for quite some time, so these instructions may be
|
||||
out of date or incomplete.<br>
|
||||
<br>
|
||||
|
||||
<h1>Ready to roll</h1>
|
||||
With the above steps completed, the LiveSupport modules and products
|
||||
With the above steps completed, the Campcaster modules and products
|
||||
are ready to be compiled and developed further. Have fun!<br>
|
||||
<br>
|
||||
<br>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue