Merge pull request #217 from apathyboy/develop

Initial commit of linux installation guide

data/docs/source/Services.rst

@@ -5,10 +5,7 @@
 
 Services
 ==================================================	
-.. toctree::
-	CombatService
-
-
+
 .. automodule:: py_swganh
 .. autoclass:: CombatService
 	:members:

data/docs/source/index.rst

@@ -1,15 +1,13 @@
-.. SWGANH Python Bindings documentation master file, created by
-   sphinx-quickstart on Thu Mar 01 18:14:27 2012.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-Welcome to SWGANH Python Bindings's documentation!
+Welcome to SWGANH documentation!
 ==================================================
 Contents:
 
 .. toctree::
    :maxdepth: 6
 
+   Installation Guide (Linux) <install_guide_linux>
+
    Scripting in SWGANH <intro>
    Script Example <script_example>
 

data/docs/source/install_guide_linux.rst

@@ -0,0 +1,161 @@
+=================
+Linux Setup Guide
+=================
+
+This chapter cover's the setup of SWGANH from source in a linux environment. This particular guide cover's installation using Ubuntu and should apply directly to most debian based flavors. Other flavors of linux should at minimum support GCC 4.6 and Python3.
+
+Installing Build Dependencies
+-----------------------------
+
+The first step in a linux build is to ensure the major dependencies for building the project are installed and available.
+
+- Git 1.7+
+- GCC 4.6+
+- CMake 2.8.5+
+- Python 3.2+
+- GLM Math Library 0.9.2+
+- Boost 1.49+
+- Boost-Log 1.1+
+- TBB (Thread Building Blocks) 3.0+
+- GTest 1.6+
+- GMock 1.6+
+- Mysql Server 5.1+
+- Mysql Connector C++ (Custom ANH Fork)
+- Sphinx (optional)
+
+In most cases modern linux distros will provide easily installable packages for most of the dependencies. First lets install the all the dependencies except for Boost, Mysql Connector C++ and Sphinx:
+
+::
+
+    sudo apt-get install g++ python3-dev python3-setuptools libmysqlclient-dev mysql-server libgtest-dev google-mock libtbb-dev libglm-dev git git-gui gitk cmake make curl unzip libbz2-dev
+    
+.. NOTE::
+
+    You may have noticed a few extra dependencies at the end, these are tools that'll make it easier to download and unpack files later on.
+
+During the installation of the above you will be asked to enter a password for the root mysql user. Be sure to remember this password for later in the installation process.
+
+The remaining dependencies require a little extra work to install properly on any linux distro. The easiest on the list is Sphinx, which is used to generate the SWGANH developer documentation. To install it on Ubuntu use the following command:
+
+::
+
+    sudo easy_install3 Sphinx
+    
+.. NOTE::
+
+    It is important that Sphinx is installed with support for Python3. The key to this is ensuring you install Sphinx using an easy_install (via the setuptools package) that was built against Python 3.
+
+Next up is Boost which needs to be linked specifically against Python3 so requires manual compilation and installation. In addition we make use of Boost-Log, a logging library that has been officially accepted into Boost but is currently in an incubation period. The interface is stable however and meets our requirments for logging.
+
+First download the latest source packages for Boost and Boost-log (at the time of this writing that is 1.49 and 1.1, respectively).
+
+::
+
+    curl -L -O http://downloads.sourceforge.net/project/boost/boost/1.49.0/boost_1_49_0.tar.bz2
+    
+    curl -L -O http://downloads.sourceforge.net/project/boost-log/boost-log-1.1.zip
+    
+Next unpack both source packages and copy the Boost-log files into the main Boost package.
+
+::
+
+    tar -xvjf boost_1_49_0.tar.bz2
+    unzip boost-log-1.1.zip
+    
+    cp -R boost-log-1.1/boost/log boost_1_49_0/boost/log
+    cp -R boost-log-1.1/libs/log boost_1_49_0/libs/log
+    
+When configuring its important to specify the version of Python that Boost should compile against. To do that use the following command.
+
+::
+
+    ./bootstrap.sh --with-python=python3.2
+
+Now that the environment is ready you can build boost by simply running the b2 command.
+
+::
+
+    ./b2
+    sudo ./b2 install
+    
+Due to a bug in the bootstrap.sh file the Python root is not detected. For builds using the Ubuntu package version of Python this is not a problem, however, if you have installed Python to a non-standard location then you may get compile errors. In that case open up the *project-config.jam* file and add the path to the Python root as in the example below.
+
+::
+
+    python : 3.2 : /usr ;
+    
+This leaves only Mysql Connector C++ left on our list. This project is the official C++ connector from Mysql, however, it doesn't appear to be in active development at this time. For this reason we have had to create our own fork to support a few features that are missing from the official source. First make sure you're not in the Boost directory from the previous step and run the following:
+
+::
+
+    git clone https://github.com/anhstudios/mysql-connector-cpp.git
+    cd mysql-connector-cpp
+    cmake .
+    make
+    sudo make install
+
+Building the SWGANH Source
+--------------------------
+
+With the dependencies out of the way the hard part is over. It's now time to checkout the SWGANH source and kick off the first build. Make sure you're not still inside the Mysql Connector C++ directory from the previous section before running these commands.
+
+::
+
+    git clone https://github.com/anhstudios/swganh.git
+    mkdir swganh/build
+    cd swganh/build
+    cmake ..
+    make
+    
+Next we'll copy in some files that are needed to run the server.
+
+::
+
+    cp -R ../data/config ./config
+    cp -R ../data/scripts ./scripts
+    cp lib/py_swganh.so .
+
+Setting up the Database
+-----------------------
+
+A new database installation is needed before the server can be started for the first time. To install the server navigate to the swganh/data/sql folder and execute the following command:
+
+::
+
+    ./setup.sh -u MYSQL_USERNAME -p MYSQL_PASSWORD
+    
+Replace MYSQL\_USERNAME and MYSQL\_PASSWORD with the authentication data of a mysql user with appropriate privileges.
+
+.. NOTE::
+
+    You can use the root user for simple local installations, however, it is advised that you create a dedicated mysql user for your SWGANH installation in production environments.
+
+Configuring and Running the Server
+----------------------------------
+
+You are now entering the home stretch, all that's left is to update the SWGANH configuration and kick off the server.
+
+Open the *swganh/build/config/swganh.cfg* file and edit the following items. First update the mysql database connection information with the address and user you used to setup the database in the previous section.
+
+Next, set the address in the *service.connection* section to your public facing IP and then save and close the file.
+
+You can now kick off the server by running this command in the *swganh/build* directory:
+
+::
+
+    ./bin/swganh
+    
+To start the server in a background process you can use a tool like screen.
+
+::
+
+    screen ./bin/swganh
+    
+Hitting *ctrl+a* then *ctrl+d* will disconnect from the screen session but will leave the server running in the background. You can rejoin the server to shut it down with the following command:
+
+::
+
+    screen -r
+    
+No output is sent to the console, you can view output from the server by viewing the log at *build/swganh.log*.
+

src/swganh/app/swganh_app.cc

@@ -185,9 +185,7 @@ void SwganhApp::Stop() {
     kernel_->GetIoService().stop();
 
     // join the threadpool threads until each one has exited.
-    for_each(io_threads_.begin(), io_threads_.end(), [] (shared_ptr<boost::thread> t) {
-        t->join();
-    });
+    for_each(io_threads_.begin(), io_threads_.end(), std::mem_fn(&boost::thread::join));
 }
 
 bool SwganhApp::IsRunning() {