From 3af883ca2fc4c0dc8f48c4a703483564f747b648 Mon Sep 17 00:00:00 2001 From: konrad Date: Sun, 27 Feb 2011 13:57:56 +0000 Subject: [PATCH] consolidate and update install docu git-svn-id: https://silmor.de/svn/softmagic/smoke/trunk@741 6e3c4bff-ac9f-4ac1-96c5-d2ea494d3e33 --- doc/build.html | 90 ++++++++++++++++++++++++++++++++---------------- doc/index.html | 3 +- doc/install.html | 101 ------------------------------------------------------ doc/server.html | 47 +++++++++++++++++++++++-- 4 files changed, 105 insertions(+), 136 deletions(-) delete mode 100644 doc/install.html diff --git a/doc/build.html b/doc/build.html index 658ee2d..809bae4 100644 --- a/doc/build.html +++ b/doc/build.html @@ -24,10 +24,68 @@ SSL-support. While the pure web-UI can run without SSL, it is highly recommended SSL for the complete server. The client insists on using SSL - it is not possible to connect the client to the server without it.

-You need a C++ compiler that works with Qt. I usually recommend GCC 4.x for Linux and other Unixoid systems and using the MinGW version that comes with the complete Qt SDK for Windows. If you happen to have a Mac please let me know what works best... ;-)

+You need a C++ compiler that works with Qt. I usually recommend GCC 4.x for Linux and other Unixoid systems and using the MinGW version that comes with the complete Qt SDK for Windows. XCode will do fine for MacOS.

The source documentation needs Doxygen in order to be built. +

Building

+ +Both server and client depend on some shared code that is pre-compiled into some of their components. So it is easiest to do a complete build (unless you are familiar with the sources).

+ +Make sure that the correct version of QMake is in your PATH (you can check this by executing qmake -version). Also note that MagicSmoke and Qt have to be compiled with the same compiler.

+ +Go to the main directory of MagicSmoke. There are a few lines at the start of the Makefile that you can adjust to better match your system (defaults should be fine for most cases).

+ +There is no support for automatic builds without MinGW on Windows. I have only tested Linux, MacOS/X and Windows/MinGW, so there is no guarantee for any other system. + +Unixoid systems:
+make rule

+ +Windows with MinGW:
+mingw32-make rule

+ +If you omit the rule parameter make will tell you which rules exist.

+ +For the install targets the makefile assumes per default that everything belongs into sub-directories of /usr/local. You can change this by adding a PREFIX variable to the call, like this:
+make -f Makefile PREFIX=$HOME/magicsmoke install
+this will instead install into the magicsmoke subdirectory of the calling users home directory.

+ +This part of the installation will place the client into its final place, and prepare the server scripts for actual installation (see below). + +

Manual Installation on Linux and Unix Systems

+ +Install the Qt4 library so that it is usable by Qt-based programs on your system. For systems that use the ELF binary format (eg. any Linux) Qt itself will take care of storing its location in the binary (RPATH). On other systems you can solve the problem by setting LD_LIBRARY_PATH or SHLIB_PATH to Qt's lib path.

+ +Make sure OpenSSL is installed and available to Qt. For the scripting interface of MagicSmoke it is also recommended to install the QtScript bindings.

+ +Copy the src/msmoke binary to the location you want to start it from. Or call:
+make -f Makefile PREFIX=/usr/local install-client
+The latter will per default install into /usr/local/bin, you can change the target by setting a different PREFIX. + +

Packages for MacOS/X

+ +Just build the entire package with:
+make macosx

+ +The src subdirectory will contain msmoke.app which can be started from the finder and msmoke.dmg which can be distributed on CD or via Web. + +

Manual Installation on Windows

+ +Copy the src/msmoke.exe binary to a path you want to start it from. Then copy the Qt DLLs to the same path. From the OpenSSL directory copy libssl32.dll and libeay32.dll to that path. You should be able to start MagicSmoke from this path on any Windows machine.

+ +If you used the full SDK of Qt to compile MagicSmoke, be sure to use the DLLs from the qt/bin subdirectory of the SDK, not the ones from bin - those are incompatible.

+ +It is recommended to copy the contents of the plugins directory from your Qt installation to that path as well - this will make sure that all image formats etc. are supported.

+ +For the scripting interface of MagicSmoke it is also recommended to install the QtScript bindings - they need to be placed in plugins/script.

+ +

Installation Package for Windows

+ +This requires the NSIS Installer.

+ +The nsis target of the Makefile will create an installation package:
+make -f Makefile nsis +

Building and Installing Packages on Debian and Ubuntu

You need a working Debian packaging environment, usually this amounts to:
@@ -50,33 +108,5 @@ You should then have three packages: You can install those packages with:
dpkg -i packagefile.deb

-For a server installation you need to create an empty database (mysql 5.x or postgres 8.x), configure your web server and install the server into its final web directory with:
-/usr/share/magicsmoke2-server/install.sh target-directory

- -

Building

- -Both server and client depend on some shared code that is pre-compiled into some of their components. So it is easiest to do a complete build (unless you are familiar with the sources).

- -Make sure that the correct version of QMake is in your PATH (you can check this by executing qmake -version). Also note that MagicSmoke and Qt have to be compiled with the same compiler.

- -Go to the main directory of MagicSmoke. There are a few lines at the start of the Makefile that you can adjust to better match your system (defaults should be fine for most cases).

- -There is no support for automatic builds without MinGW on Windows. I have only tested Linux, MacOS/X and Windows/MinGW, so there is no guarantee for any other system. - -Unixoid systems:
-make rule

- -Windows with MinGW:
-mingw32-make rule

- -If you omit the rule parameter make will tell you which rules exist.

- -For the install targets the makefile assumes per default that everything belongs into sub-directories of /usr/local. You can change this by adding a PREFIX variable to the call, like this:
-make -f Makefile.unix PREFIX=$HOME/magicsmoke install
-this will instead install into the magicsmoke subdirectory of the calling users home directory. - -

Installation

- -Use the install targets above for installation on a Unixoid system.

+See the Server Installation page on how to install a server instance afte installing the package.

-See the Installation page for details. diff --git a/doc/index.html b/doc/index.html index f9b78be..d834e09 100644 --- a/doc/index.html +++ b/doc/index.html @@ -55,8 +55,7 @@ to be written:

Building/Installing Magic Smoke