root/tags/omero-3.0-M1/README.txt
| Revision 668, 2.9 kB (checked in by jmoore, 3 years ago) |
|---|
| Line | |
|---|---|
| 1 | |
| 2 | ------------------------------------------------- |
| 3 | OMERO - OME Remote Objects Server |
| 4 | ------------------------------------------------- |
| 5 | |
| 6 | ................................................. |
| 7 | .WARNING: Omero is currently in development mode. |
| 8 | . and should be considered BETA. . |
| 9 | ................................................. |
| 10 | |
| 11 | INSTALLATION: |
| 12 | ------------ |
| 13 | |
| 14 | |
| 15 | (1) Requirements |
| 16 | |
| 17 | |
| 18 | Install a Java 5 Development Kit (JDK). The Omero server code |
| 19 | requires Java 5. Set the JAVA_HOME environment variable to your JDK |
| 20 | installation |
| 21 | |
| 22 | Install the JBoss EJB3 profile (4.0.4RC1 installer) Set JBOSS_HOME |
| 23 | to your jboss Installation. You can get this version from |
| 24 | |
| 25 | http://users.openmicroscopy.org.uk/~jmoore/JBOSS_DEMO/jboss-4.0.4RC1.zip |
| 26 | |
| 27 | if no where else. |
| 28 | |
| 29 | |
| 30 | (2) Building |
| 31 | |
| 32 | |
| 33 | ### The following can be cut-n-pasted into bash.####################### |
| 34 | # |
| 35 | |
| 36 | # Assuming OMERO_HOME has been set. |
| 37 | |
| 38 | cd $OMERO_HOME |
| 39 | |
| 40 | # For the following you'll need to have java on your PATH, and |
| 41 | # JAVA_HOME set. If CLASSPATH is set, you'll either need to include |
| 42 | # the "dot" directory, or specify "java -cp ." |
| 43 | # (In most cases, this would be identicial to the call "ant copy-examples") |
| 44 | |
| 45 | |
| 46 | java omero copy-examples |
| 47 | |
| 48 | |
| 49 | # or cp OMERO_HOME/docs/examples/*.properties.example OMERO_HOME |
| 50 | # edit these properties for your site (Don't add to revision control) |
| 51 | # Vital are __hibernate.properties__ for connecting to your database, |
| 52 | # and __omero.properties__ for finding your libraries |
| 53 | # |
| 54 | # If using postgres |
| 55 | |
| 56 | dropdb omero3 # if you've tried this before, else reload-db will fail |
| 57 | createdb omero3 |
| 58 | |
| 59 | java omero fullbuild # same as "clean model install reload-db" |
| 60 | java omero deploy |
| 61 | |
| 62 | java omero start-as-jboss # or sh bin/run.sh from JBOSS_HOME |
| 63 | |
| 64 | # You can also add the "__quick__" target to prevent testing. E.g.: |
| 65 | # |
| 66 | # java omero quick fullbuild |
| 67 | # |
| 68 | # You will also need to make sure that the directory /OME/OMEIS exists |
| 69 | # until http://bugs.openmicroscopy.org.uk/show_bug.cgi?id=661 is fixed |
| 70 | # |
| 71 | ### Omero should now be ready for use ################################# |
| 72 | |
| 73 | |
| 74 | (3) Further reading |
| 75 | |
| 76 | |
| 77 | For more information on installation and developing omero, |
| 78 | please see the OMERO wiki at : |
| 79 | |
| 80 | http://cvs.openmicroscopy.org.uk/tiki/ |
| 81 | |
| 82 | Especially: |
| 83 | |
| 84 | * Getting Started: |
| 85 | http://cvs.openmicroscopy.org.uk/tiki/tiki-index.php?page=Omero+Getting+Started |
| 86 | |
| 87 | * Omero Design: |
| 88 | http://cvs.openmicroscopy.org.uk/tiki/tiki-index.php?page=Omero+Design |
| 89 | |
| 90 | |
| 91 | (4) Contents |
| 92 | |
| 93 | |
| 94 | The contents of this directory ("OMERO_HOME") are: |
| 95 | |
| 96 | README.txt: |
| 97 | this file |
| 98 | |
| 99 | components: |
| 100 | directory containing artifacts for the build |
| 101 | |
| 102 | pom.xml: |
| 103 | a Maven Project Object Model (POM) defining the |
| 104 | build dependencies |
| 105 | |
| 106 | omero.properties: |
| 107 | property values for the build (global) |
| 108 | |
| 109 | hibernate.properties: |
| 110 | property values specifically for Hibernate |
| 111 | |
| 112 | log4j.properties: |
| 113 | logging configuration for all components |
| 114 | |
| 115 | docs: |
| 116 | documentation, license (LICENSE), and |
| 117 | various example files. |
| 118 | |
| 119 | lib: |
| 120 | libraries necessary for ant build including ant itself. |
| 121 |
Note: See TracBrowser
for help on using the browser.
