| 3 | | =========================================================================== |
| 4 | | CAUTION CAUTION CAUTION -- this is outdated! stay tuned for a new version! |
| 5 | | =========================================================================== |
| 6 | | old version follows. |
| 7 | | =========================================================================== |
| 8 | | |
| 9 | | This file describes how to get the package up and running. |
| 10 | | |
| 11 | | Prerequisites: |
| 12 | | |
| 13 | | * A unixoid OS. Yes, Java should be platform independent. |
| 14 | | Unfortunately portions of the build environment and code |
| 15 | | require a unix-like shell. Running Pustefix on Windows might |
| 16 | | work using Cygwin, but we haven not tried yet. If you succeed |
| 17 | | in running Pustefix on Windows, we would like to hear. |
| 18 | | |
| 19 | | * A Java installation. Version 1.5 is required and version 1.6 |
| 20 | | is recommended. The environment variable JAVA_HOME must be |
| 21 | | set to the root directory of your java installation. |
| 22 | | |
| 23 | | * Apache Ant, the Java-based build tool in version 1.7.0 or higher. |
| 24 | | If you have really large projects consider increasing the memory |
| 25 | | for the java vm ant runs in: To do this set the ANT_OPTS |
| 26 | | environment variable to something like "-mx200m". This variable |
| 27 | | is evaluated within the ant start script contained in the ant |
| 28 | | distribution. |
| 29 | | |
| 30 | | * If you want to use Pustefix with the Apache HTTP daemon, either |
| 31 | | mod_proxy_ajp or mod_jk have to be installed and loaded. |
| 32 | | However, you can simply run Pustefix without Apache by setting |
| 33 | | the standalone.tomcat property to true when running "ant". |
| 34 | | Tomcat will listen for incoming HTTP connections on port 8080 |
| 35 | | and for HTTPS connections on port 8443. |
| 36 | | |
| 37 | | If you are using Apache, name-based virtual servers have to be |
| 38 | | enabled for the default address of your machine. |
| 39 | | |
| 40 | | Note that there have been problems with the order of |
| 41 | | inclusion of mod_rewrite and mod_jk in the Apache configuration |
| 42 | | file. It seems that mod_jk needs to be loaded |
| 43 | | BEFORE mod_rewrite. If you experience problems, try changing |
| 44 | | the order of these two modules. Other problems that have |
| 45 | | been experienced are related to a changed regexp syntax |
| 46 | | between different versions of mod_rewrite. You may have to |
| 47 | | customize the relevant regexps in the file core/build/create_apacheconf.xsl. |
| 48 | | |
| 49 | | * You should have a "* entry" for your machine in DNS (This means that |
| 50 | | a lookup to NAME.HOSTNAME.DOMAIN should resolve to HOSTNAME.DOMAIN no |
| 51 | | matter what NAME is). If you don't have DNS configured like this you can |
| 52 | | still supply the names (e.g. "cms.HOSTNAME.DOMAIN" or |
| 53 | | "sample1.HOSTNAME.DOMAIN") via your /etc/hosts file. |
| 54 | | |
| 55 | | * NOTE: you don't need a external installation of Tomcat, |
| 56 | | everything you need is contained in this package. We suggest |
| 57 | | that even if you have your own Tomcat setup already, |
| 58 | | start by using the supplied versions, and, if all goes |
| 59 | | well, you can try to move the configuration into your own |
| 60 | | installation. |
| 61 | | |
| 62 | | * NOTE2: you don't need any additional jar files or classes besides |
| 63 | | what is supplied with your java installation and this package. |
| 64 | | |
| 65 | | 1) Type "ant" to generate all neccesary files and compile all classes. |
| 66 | | |
| 67 | | 2) You may want to type "ant generate" for pre-processing all the templates |
| 68 | | up-front. This speeds up the first hit of a page in the sample |
| 69 | | applications as the page doesn't need to be build from scratch then. |
| 70 | | |
| 71 | | 3) Put something like the following |
| 72 | | |
| 73 | | NameVirtualHost HOSTNAME.DOMAIN:80 |
| 74 | | # uncomment if you want to use SSL |
| 75 | | # NameVirtualHost HOSTNAME.DOMAIN:443 |
| 76 | | |
| 77 | | # config for mod_jk |
| 78 | | Include <your path to this directory>/projects/servletconf/tomcat/jk.conf |
| 79 | | |
| 80 | | # virtual hosts: |
| 81 | | Include <your path to this directory>/projects/servletconf/tomcat/apache.conf |
| 82 | | |
| 83 | | into your Apache configuration. Don't forget to restart apache. |
| 84 | | Modern apache installations often have a httpd.conf.d directory where |
| 85 | | to put links to config files that should be included automatically. |
| 86 | | In this case you can link the two files there instead of including them |
| 87 | | via your http.conf |
| 88 | | |
| 89 | | 4) Start Tomcat with the following command: |
| 90 | | |
| 91 | | ./startTomcat.sh |
| 92 | | |
| 93 | | Note: For stopping Tomcat, just press Control-C to interrupt the script. |
| 94 | | |
| 95 | | 5) To see if everything works, you can try to open the editor |
| 96 | | application. Point your browser to |
| 97 | | |
| 98 | | http://cms.HOSTNAME.DOMAIN |
| 99 | | |
| 100 | | 6) You will find some basic applications in the example.tar.gz. |
| 101 | | Just unpack the file with "tar xvzf example.tar.gz" in your skel/projects |
| 102 | | directory and take a short look to the README_EXAMPLES.txt included in the |
| 103 | | tar afterwards. |
| 104 | | |
| 105 | | 7) Creating your own pustefix project is really simple. If you're in |
| 106 | | the skel dir just type in "./newproject.sh" |
| 107 | | and follow the command-line |
| 108 | | instructions. |
| 109 | | Afterwards run ant, restart apache, restart tomcat and type in |
| 110 | | http://myprojectname.HOSTNAME.DOMAIN |
| 111 | | |
| 112 | | To see how it works you should take a short look in |
| 113 | | de.schlund.pfixcore.util.basicapp. |
| 114 | | If you start with InitNewPfixProject.java (in the package basics) it should |
| 115 | | be easy to understand the way to go |
| 116 | | |
| 117 | | Have Fun. |
| 118 | | |
| 119 | | |
| 120 | | FINAL NOTE: |
| 121 | | |
| 122 | | You can now start building your own applications. Some tutorials as well as the |
| 123 | | reference documentation can be found on http://www.pustefix-framework.org/. |
| 124 | | |
