Nuxeo Enterprise Platform 5.3
Contents
1. Command Options Command options are defined by a name and optionally a shortcut a short name When referring to an option using its name you should prefix it by two hyphens When using short names you should only use one hyphen as a prefix For example if you have an option named host and using a short name of h the following commands are equivalent Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxXe o Nuxeo Enterprise Platform 5 3 Documentation Center PPS ee eee Aan lan lanian S nxshell sh interactive h localhost nxshell sh interactive host localhost Options may take values or may be used as flags turning on off a specific option by their simple presence When using long names you should specify the option values immediately after the option However when using short names you can group options together Let say for example we have a command that support four options a v i o a and v are flag options and both i and o take an argument as value In this case you can group options like the two following examples command avi in file o out_file command avio in file out_file You should keep in mind that when grouping options taking arguments those arguments will be assigned to each of these options in the order they were specified on the command line Global Options Besides the specific options2. If you installed Nuxeo as a Windows service automatically done when using the Nuxeo installer for Windows you can use the service for starting the server instead of the Nuxeo control panel Connect to the server using your web browser 1 Open a browser and type the URL http localhost 8080 nuxeo 2 Log in to Nuxeo EP using the Administrator user name and the Administrator password Once logged with superuser credentials you can start creating regular users and groups and organize your folders The dedicated user guides will help you figure out the main features of Nuxeo products Configuring Nuxeo EP Simple configuration with nuxeo conf Nuxeo is mainly configured by editing the nuxeo conf file located in the bin folder of your Nuxeo server Cutomizing the default nuxeo configuration takes 3 steps 1 Copy the nuxeo conf file It is better but not mandatory to store your customized nuxeo conf outside Nuxeo This way you will be able to easily upgrade Nuxeo keeping your configuration safe apart of Nuxeo directory 2 Edit it 3 Start your server and tell Nuxeo where to find the customized nuxeo conf Below are the instructions for Linux Mac OS X and Solaris users and for Windows users Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxX o Nuxeo Enterprise Platform 5 3 Documentation Center PPS eee e
3. 5 3 Documentation Center nuxeo log dir nuxeo pid dir nuxeo data dir nuxeo force generation nuxeo templates nuxeo bind address org nuxeo ecm instance name org nuxeo ecm instance description org nuxeo ecm product name org nuxeo ecm product version org nuxeo ecm webapp dashboard mode templateName target mailservice user mailservice password mail store protocol mail transport protocol mail user log bin data true default 0 0 0 0 Nuxeo 5 3 Nuxeo ECM server Nuxeo DM 5 3 2 auto server default deploy nuxeo ear nobody password pops smtp nobody Copyright 2010 2013 Nuxeo Log directory relative to NUXEO_HOME Directory where to store Nuxeo PID file Nuxeo data directory If true will force generation of configuration files otherwise they are only generated when not existing Comma separated list of templates to include Templates paths must be absolute or relative to NUXEO_HOME templates JBoss only Server binding address 0 0 0 0 means all available network interfaces Server name Server description Directory where templateName files will be deployed JBoss only User for mail authentication JBoss only Password for mail authentication JBoss only Server protocol parameters for mailing JBoss only User who will receive mail unused in Nuxeo This documentation is published under Creative Common BY SA li
4. License page nuxXe oO Nuxeo Enterprise Platform 5 3 Documentation Center PPS eee ee ey nuxeo db host localhost nuxeo db name nuxeo nuxeo db user user nuxeo db password password Advanced configuration with nuxeo conf and templates The templates in the directory templates are used to generate configuration and datasource files at server startup when it is not already configured Usage General instructions Edit nuxeo conf and choose the name of the template s you want For instance to switch from default configuration with Derby database to recommended PostgreSQL replace p Teee e a a a E E E E E E E E E E E M N E E E E N E E E E E a a a a a a a a ee mmmn M y Default values are used for undefined properties in nuxeo conf Take care that the following sample is defining an empty property Do not edit nuxeo defaults files under the templates directory except if needed the one in custom template Technical overview A server is considered as already configured when it has a config directory When the config directory doesn t exist templates will be used to generate all configuration files config and datasources The template files contain defined parameters such as sample parameter Values for parameters replacement are calculated this way e f nuxeo conf does not define nuxeo templates then nuxeo templates equals default the deprecated parameter nuxeo template is still read for backward compatibil
5. Nuxeo Enterprise Platform 5 3 Documentation Center P M m m eee ee ey ee ee ee eee eee ee ee ee ee ee ee eee M leet tt eet tte PS See ee eee ey This command can be used as a starting point to write another script to perform search service queries if needed This command is only available in the Nuxeo 5 2 branch Istypes viewtype Isusers Isgroups viewuser viewgroup Troubleshooting Check listened IP Be sure on what precise IP address and what precise port the server is listening to To find out use the netstat com mand on the server host The example below shows that on the same host there are 2 servers listening on the 62474 port but on different IP addresses You should always use as arguments to the nuxeo shell the exact IP address and port you find out Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxeo Nuxeo Enterprise Platform 5 3 Documentation Center sudo netstat ntlap grep 62474 tcp 0 O f f f 192 0 0 11 62474 sis LISTEN 3623 java tcp 0 O f f f 192 0 0 10 62474 oa LISTEN 1346 java Alternatively you can use the lsof command sudo lsof i 62474 COMMAND PID USER FD TYPE DEVICE SIZE OFF NODE NAME java 3623 jboss 266u IPv6 0x5d69a70 OtO TCP 62474 LISTEN i java 1346 jboss 266u IPv6 0x5d7af30 OtO TCP 62474 LISTEN eee eee eld Check connected server Be su
6. that commands may define there are several global options applying to all commands They are host host or h the Nuxeo EP host where to connect to defaults to localhost port port or p the Nuxeo EP port where to connect to defaults to 62474 e username username or u the username to use defaults to the system user password password or P the password to use e debug debug or d to start with debug mode logs at DEBUG level Commands Here is the list of all built in commands of nuxeo shell Notes e At the time of this writing some of these built in commands are not yet implemented Those are be marked with an asterisk e The commands can be grouped in two categories offline commands not needing a connection to work For instance help log etc e online commands requiring a connection to work These commands are automatically connecting if no connection is currently established e Some commands for which offline online make no sense and are not available in both modes batch and interactive This will be specified in such a case Look at the included README txt for an up to date list of available commands Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxe Nuxeo Enterprise Platform 5 3 Documentation Center interactive Runs in the interactive mode This command is not availa
7. Common BY SA license More details on the Nuxeo Documentation License page nuxeo Nuxeo Enterprise Platform 5 3 Documentation Center The application is based on the Nuxeo Runtime framework and thus offers the same extension point mechanism you can find on the server application The main features of the command line tool are Two operating modes an interactive and a batch mode Advanced command line editing like auto completion command history command line colors command line shortcuts like CTRL K CTR A etc JSR223 scripting integration You can thus connect and execute commands on a Nuxeo server in pure scripting mode e Extensibility using Nuxeo Runtime extension points The advanced command line handling is done using the JLine library The only requirement is Java The tool works on any Linux like OS on Windows and on Mac OS X e Overview e Download Nuxeo Shell Build Nuxeo Shell e User Manual e Command Options e Global Options e Commands interactive connect disconnect useradd groupadd groupmod select e viewtype lsusers Isgroups 2 Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxXe o Nuxeo Enterprise Platform 5 3 Documentation Center e viewuser e viewgroup e Troubleshooting e Check listened IP e Check connected server e Multi machine case e Extend
8. EBUG on console and filenames See log4j documentation for more information Available only in interactive mode connect Connects to a given server If a connection is already established close it first Available only in interactive mode disconnect Disconnects from the current connected server If no connection exists does nothing Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nmuxeo Nuxeo Enterprise Platform 5 3 Documentation Center Available only in interactive mode Is Lists the children of the current folder in the repository By default Folderish types are displayed in blue Note that the Is directory name command is accepted but won t list the content of directory name it will only list the content of the current directory This might be improved in the future to provide a behavior alike the one of the Unix ls command Available only in interactive mode tree Displays the complete tree structure of the documents as it would be returned by the Unix tree command Available only in interactive mode cd Changes the current directory in the repository to a Folderish document pwd Displays the current path in the repository view Views info about document The information displayed can be controlled using these command options all a view all data system s view only the system data acp view
9. I uU Xe O Content Management Platform For Business Applications Technical Documentation Released on 02 11 13 1 Nuxeo EP 5 3 Documentation Center 1 1 Installation and Administration Guide aaa aaa aa aaa a eee eee eee ee eee eens 1 1 1 Nuxeo EP 5 3 2 Installation Guide 1 eee eee nee ee nee een een enna 1 1 1 1 Hardware Software and OS Requirements 0 cece ee eee tenet eee eens 1 1 1 2 Installing Nuxeo EP Tei GOntiguring INUXCOVEP sares ee Oe a a Osa ee oe Oe ore Ose hy SOR eh ae ea BeOS eee eee eas 1 1 1 3 1 Available Parameters for nuxeo conf 5 3 2 2 0 cee eee eee eee eens 1 1 2 Managing your application with Nuxeo RMI Shell command line tool 0 0 eee 1 2 Set up the Nuxeo Admin Center nuxeo Nuxeo Enterprise Platform 5 3 Documentation Center Nuxeo EP 5 3 Documentation Center Welcome on Nuxeo EP 5 3 Documentation Center This doc center refers to the 5 3 version of Nuxeo EP and explains how to install this version of Nuxeo EP You may want to check the documentation for the latest version of Nuxeo EP for more information about the platform Download ej Download this documentation in PDF License This documentation is copyrighted by Nuxeo and published under the Creative Common BY SA license More details on the Nuxeo documentation license page Recently updated Set up the Nuxeo Admin Center updated Dec 07 2012 view change Nuxeo EP 5 3 Document
10. ation Center e For Mac OS users e Recommendations e Hardware configuration e Default configuration e For optimal performances e Known working configurations e OS JV e Storage backends e LDAP lt Requirements Nuxeo EP can run on Linux Mac OS X and Windows operating systems All you need for a quick start is e Java Development Kit JDK a JRE is not enough Nuxeo EP is fully based on Java This means that Nuxeo can easily be deployed on any platform with a Java Software Development Kit SDK It is required to use either Java 1 5 also called Java 5 or Java 1 6 also called Java 6 Java 6 is the preferred version if you have the choice We recommend Sun s JRE and don t support other JDK Don t hesitate to contact us if you need us to support a JDK from another vendor e Java EE server with EJB 3 support enabled or simple servlet container Nuxeo packages include either JBoss Tomcat or Jetty Check your Java version Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxX o Nuxeo Enterprise Platform 5 3 Documentation Center P M m om eee eee 1 Open a terminal e on Linux or Mac OS open a terminal e on Windows press windows key r type cmd or command in the run window and press OK or open the Prompt command from Start gt Programs gt Accessories menu 2 Type java ve
11. ation Center updated Dec 05 2012 view change Managing your application with Nuxeo RMI Shell command line tool updated Sep 05 2012 view change Installing Nuxeo EP updated Sep 05 2012 view change Nuxeo Shell updated Dec 28 2011 view change Available Nuxeo Distributions updated Dec 15 2011 view change Available Parameters for nuxeo conf updated Nov 16 2011 view change About the content repository updated Sep 13 2011 view change Platform features quick overview updated Sep 13 2011 view change Repository access updated Sep 02 2011 view change Installation and Administration Guide Table of Contents Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxXe o Nuxeo Enterprise Platform 5 3 Documentation Center e Nuxeo EP 5 3 2 Installation Guide e Hardware Software and OS Requirements e Installing Nuxeo EP e Configuring Nuxeo EP e Managing your application with Nuxeo RMI Shell command line tool Nuxeo EP 5 3 2 Installation Guide Welcome to the Nuxeo EP Installation Guide Nuxeo EP is the base platform for Nuxeo products here are common instructions for all products Nuxeo EP can be installed on any computer providing that Java is installed Depending on the product we provide various packagings ZIP archive Windows installer Debian package The ZIP archive is the reference ot
12. ble when already in interactive mode Has no specific options Pt eee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee eee Hy S nxshell sh interactive Displays the help page Takes an optional parameter which is the name of a command By default displays the global help page If a command is given as an argument displays the help page for that command ee eee ee eee eee ee ee ee ee ee ee ee ee ee my Manage logs from console without having to edit log4j xml Allow to switch on off a debug mode add remove loggers log filename log level package or class creates a file in SPWD 1log if filename does not contain path separator else given path is used It will record logs at level greater or equal to level if specified else default level is INFO available values are TRACE DEBUG INFO WARN ERROR FATAL If a package or a class canonical name is specified logs will be filtered from this package class log off package or class stops logging Applies on all custom appenders console and filenames if no pa ckage or class is specified Don t worry about the warning log off command may cause the logger is re created log4j WARN No appenders could be found for logger org nuxeo ecm shell commands InteractiveCommanda log4j WARN Please initialize the log4j system properly log debug switches debug mode on off Same result as starting the shell with d debug option This decrease the log level to D
13. cense More details on the Nuxeo Documentation License page nuxXe o Nuxeo Enterprise Platform 5 3 Documentation Center mail pop3 host mail debug nuxeo notification eMailSubjectPrefi X mail smtp host mail smtp port mail smtp auth mail smtp username mail smtp password mail from nuxeo db name nuxeo db user nuxeo db password nuxeo db host nuxeo db port nuxeo db min pool size nuxeo db max pool size nuxeo vcs min pool size nuxeo vcs max pool size nuxeo url org nuxeo ecm contextPath pop3 nosuchhost nosuchdomain co m false Nuxeo localhost 25 true anonymous password noreply nuxeo com nuxeo NUXEO sa nuxeo password localhost 3306 1521 5432 20 20 http localhost 8080 nuxeo nuxeo Copyright 2010 2013 Nuxeo JBoss only Mail server JBoss only Enable debugging output from the javamail classes Subject prefix in Nuxeo notification mails SMTP gateway server Mail server port The address mails will be sent from Database name Database username Database password Database host URL Database host port Database minimum pool size for Nuxeo datasources Database maximum pool size for Nuxeo datasources Database minimum pool size for Nuxeo repository VCS Database maximum pool size for Nuxeo repository VCS Application URL Tomcat only Application context path This documentation is published under C
14. eds to at least contain the following dependency to be able to build extend the AbstractCommand class Building the plugin will generate a XXX jar file Note that you should of course replace the version given as an example with the version suited for your need ee ee ee ee ee eee ee ee ee ee ee ee ee ee ee lt dependencies gt eae lt dependency gt lt groupId gt org nuxeo ecm platform lt groupId gt lt artifactId gt nuxeo shell commands base lt artifactId gt lt version gt 5 1 7 SNAPSHOT lt version gt lt dependency gt Fere lt dependencies gt Deploying the shell plugin 1 Install or decide on using an already installed Nuxeo Shell 2 Copy the generated XXX jar file into the bundles directory of the Nuxeo Shell 3 Delete the Nuxeo Shell data directory if there is any This is for purging any cache of registered JARS The next time the Nuxeo Shell will be started your new commands will be available Set up the Nuxeo Admin Center To set up the Nuxeo Admin Center for Nuxeo DM EP 5 3 2 follow these instructions Since 5 4 Nuxeo Admin Centre is automatically included in Nuxeo product releases Pt ee ee ee ee ee ee ee ee ee ee ee ee m ee ee ee ee ee ee ee ee eee Hy 1 ADMIN Download the zip that contains the required plugins 5 files with the jar extension 2 Unzip all the jar files in the correct folder e JBoss distribution SHOME NUXEO server default deploy nuxeo ear plugins e Tomcat distribution SNUXEO HOME nx
15. her packages will install the same content as the ZIP archive adapting the deployment to the target platform We also provide those products embedded in various J2EE servers JBoss Tomcat Jetty for development only Even if the structure changes the Nuxeo content is the same install and configuration procedures are unchanged Detailed install instructions e Hardware Software and OS Requirements e Installing Nuxeo EP e Configuring Nuxeo EP e Available Parameters for nuxeo conf 5 3 2 e Use our discussion forums to share your experience connect to other users and get help e Subscribe to the ECM list to stay informed about the evolution of the platform e Follow us on LinkedIn Facebook and Twitter Hardware Software and OS Requirements This section presents information about the running environment for a Nuxeo server Listing all required software giving a recommended configuration and listing some others Known as operational this sections aims at helping you to validate or define your production environment but the list is not exhaustive and needs to be completed with the users experience Outline of this document e Requirements e Check your Java version e Install Java e For Windows users e For Linux users Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxXe o Nuxeo Enterprise Platform 5 3 Document
16. ing the shell e Registering New Custom Commands e Java Code for the new commands e Building the shell plugin e Deploying the shell plugin Download Nuxeo Shell Since Nuxeo 5 3 Nuxeo Shell is included in most of distributions You can download latest released version from here Previous versions are available from this page Build Nuxeo Shell Nuxeo Shell is built with Maven from http hg nuxeo org nuxeo nuxeo distribution leet ttt etter Result is in nuxeo distribution shell target as a ZIP file User Manual The Nuxeo Shell application is packaged as a zip archive To install it you need to unzip and copy the content in a folder See README txt in Nuxeo Shell for detailed information and usage samples You can run the application in two modes 1 Batch mode in this mode you specify the command that will be executed After the command execution the process will exit The command has to be passed as the first argument Here is an example of a command executed in batch mode ltt ee a I I nxclient sh console export path to remote doc path to local folder h 192 168 2 54 u Administrator P AdminPassword beam ee o o Ee EE ee eee eee eee eee ol Here is an example of a command executed in batch mode while also passing parameters Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxXe o Nuxeo Enterpr
17. ise Platform 5 3 Documentation Center nxclient sh console ls host 192 168 2 54 u Administrator P AdminPassword 2 Interactive mode in this mode you can share a single session to run multiple commands against the remote Nuxeo EP To start the application in that mode you should run the interactive command in one of two ways Pe ee ee ee ee ee eee ee ee ee ee ee ee ee ee ee eee nxclient sh interactive nxshell sh After entering in interactive mode a command prompt will be displayed At this prompt you can enter commands in the same way you specify them on the command line in batch mode When not connected to a server the prompt will be displayed as gt After connecting to a server named let s say nuxeo platform the prompt will be displayed as nuxeo pla tform gt SO aS we ve seen in the above examples executing a command is done by using the following syntax comm and options parameters where options and parameters are optional and are specific to the command you run Example Pt ee ee ee ee ee ee ee ee ee ee ee ee eee ee ee ee ee ee ee ee ee eee Hy In this case import is the command u is a flag option path to doc and path to local file a re both parameters Parameters are stand alone arguments they are not bound to a specific option and can be retrieved programmatically using their index In the example above the first parameter will have the index 0 while the second the index 1
18. ity Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxeo Nuxeo Enterprise Platform 5 3 Documentation Center e The nuxeo templates value is used for determining the chosen template s e For each value nuxeo template of nuxeo templates comma separated values relative to templates directory or absolute path the corresponding file templates nuxeo template nuxeo defaults is read for defining new default values and maybe including other templates which are recursively parsed e The file templates nuxeo defaults is read for default values not already defined e The file nuxeo conf is read for custom values overwriting default values Configuration files are then generated by this way e For each comma separated value of nuxeo templates and nuxeo template includes let say sample template files in templates sample template are copied using the previously calculated values for replacing parameters e Every included template will potentially overwrite its precedents Customization custom template allows to add customization such as using multiple databases configuring services e Add your own template files in templates custom directory You can use either existing or new parameters in these new template files e Edit nuxeo conf set your parameters values and set nuxeo templates custom You can refer
19. k lt documentation gt lt extension target org nuxeo ecm shell CommandLineService point commands gt lt command name purgeobsoletedocs gt lt description gt Purge obsolete documents considering based on predefined hard coded logic lt description gt lt help gt Purge obsolete documents lt help gt lt command gt lt command name addapplicants gt lt description gt Adds applicants by creating the right folders with the right permissions lt description gt lt params gt lt param index 0 type path gt lt params gt lt help gt Adds applicants lt help gt lt command gt lt extension gt lt component gt Java Code for the new commands This is how to write a Java class for anew command public class ApplicantsAdderCommand extends AbstractCommand public static final String COMMAND NAME addApplicants public void run CommandLine cmdLine throws Exception String elements cmdLine getParameters parse command line if elements length 1 log error Usage COMMAND NAME file return File file new File elements 0 addApplicants void addApplicants Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nmuxe oO Nuxeo Enterprise Platform 5 3 Documentation Center Building the shell plugin Finally the pom xml file for the plugin to the Nuxeo shell ne
20. re to be connected on the right server To do so issue a view command This will display information on the current context UID 2a13db70 133 473c 9a90 6838d01610aa Path Type Root Title 2a13db70 133 473c 9a90 6838d01610aa Author null Created null Last Modified null Multi machine case When working with multi machine installation connect the Nuxeo Shell on the server running Nuxeo Core i e the stateful server on a bi machine configuration Extending the shell If you a need a new command a new functionality not provided by the Nuxeo Shell you can add it very simply by writing a Nuxeo plugin in exactly the same manner you would for a Nuxeo server instance This is done by writing a Java class for each new shell command and declaring that is registering each command in a single XML file as a contribution to an extension point Here is an example of how to register two imaginary new custom commands addapplicants and purgeobsolet edocs Registering New Custom Commands This is how to register the new commands Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxXe o Nuxeo Enterprise Platform 5 3 Documentation Center lt xml version 1 0 gt lt component name com company nuxeo shellcommands version 1 0 gt lt documentation gt Extra Nuxeo Shell commands shown as examples for the Nuxeo Boo
21. reative Common BY SA license More details on the Nuxeo Documentation License page nuxeo Nuxeo Enterprise Platform 5 3 Documentation Center org nuxeo ecm platform transform o 127 0 0 1 DEPRECATED oo host name org nuxeo ecm platform transform o 8100 DEPRECATED oo host port org nuxeo ecm platform transform o 2 2 1 DEPRECATED oo version org nuxeo ecm platform transform o true DEPRECATED oo enableDaemon opensocial gadgets host localhost opensocial gadgets port 8080 opensocial proxy proxySet false opensocial proxy proxyHost opensocial proxy proxyPort opensocial proxy user opensocial proxy password Managing your application with Nuxeo RMI Shell command line tool Deprecation Warning The Nuxeo RMI Shell is deprecated since the version 5 4 0 1 of Nuxeo You should consider using the Nuxeo HTTP Shell instead Overview The Nuxeo Shell is a command line tool for everyone who needs simple and quick remote access to a Nuxeo server You can see it as the Swiss army knife for the Nuxeo EP world It can be used by regular users to browse or modify content by advanced users to administrate Nuxeo servers or by programmers to test and debug The Nuxeo Shell is designed as an intuitive and extensible command line application It can both serve as a user administrator or programmer tool or as a framework to develop new Nuxeo command line clients Copyright 2010 2013 Nuxeo This documentation is published under Creative
22. rsion and press Enter If Java is correctly installed on your computer the name and version of your Java virtual machine is displayed Pes BB BB BBB ee java version java version 1 6 0_20 Java TM SE Runtime Environment build 1 6 0 20 b02 279 10M3065 Java HotSpot TM 64 Bit Server VM build 16 3 b01 279 mixed mode If Java is not installed on you computer it fails to display the java version Then you need to install Java If Java is installed but not included in the PATH it fails to find the java command Then you need to add JAVA_HOME bin in your PATH see How do set or change the PATH system variable Install Java For Windows users Pt ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee eee Hy 1 Download it from Sun website and choose the appropriate platform for your hardware and Windows version 2 Run the downloaded exe file and follow instructions For Linux users On a modern Linux distribution you can now install Sun Java 6 with the packaging system of your distribution using rom apt yum etc If the JDK from Sun is not available for your OS you can still download it from Sun website amp Since Ubuntu 10 4 Lucid Lynx sun java 6 is available from partners software sources apt repositories For Mac OS users An appropriate version of Java should already be installed on your computer if you are using either Mac OS X Leopard Java 5 or Snow Leopard Ja
23. server bundles 3 Download the library ADMIN nuxeo connect client and copy it to the lib folder e JBoss distribution SHOME NUXEO server default deploy nuxeo ear 1lib e Tomcat distribution SNUXEO HOME nxserver 1lib 4 Restart your server 5 Connect with Administrator credentials and click on the Admin Center link in the header 6 Register your instance with the Nuxeo Connect portal Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page
24. the ACLs on that document rm Removes a document or a tree of documents mkdir Creates a Folder document put Uploads a blob to a file document If the target document doesn t exists creates it putx Creates a document other than a file Metadata and blobs are specified in the Nuxeo export format get Downloads the blob from a File document Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxXe o Nuxeo Enterprise Platform 5 3 Documentation Center getx Gets a document as an XML file as export but only for a document export Exports documents from the repository import Imports documents into the repository script Makes it possible to run external scripts Here are examples of such scripts From interactive mode use Pt ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee ee eee Hy Changes a privilege on the given document useradd Creates new user s To create user joe useradd joeTo create the users define in the users csv CSV file lt a m m e j groupadd Creates new group s groupmod Modifies a group To add user joe to the company service1 group lt To set the users of the company service1 group to be only joe Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxXe o
25. to custom templates directory with a relative path or to your own custom templates directory with an absolute path e Edit custom nuxeo defaults and set nuxeo template includes parameter to define the list of existing templates to include comma separated values your custom template will be used at last nuxeo defaults files from included templates are also read In case you need multiple customizations create multiple directories and reference them in a dedicated nuxeo conf for each server Available templates default Default Nuxeo configuration Designed for development or test purpose Repository backend H2 Services backend Derby postgresql recommended Recommended configuration for production based on PostgreSQL Think to add PostgreSQL JDBC driver into server default lib directory Repository backend PostgreSQL XA Services backend PostgreSQL XA mysql Repository backend MySQL XA Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxe Nuxeo Enterprise Platform 5 3 Documentation Center Services backend MySQL oracle Repository backend Oracle XA Services backend Oracle stateful and stateless deprecated Configuration separating stateful and stateless services see Nuxeo documentation for details using default values for database custom Sample custom template It s quite empty feel free to pla
26. use but it is not made for performance Nuxeo 5 3 uses e H2 for SQL Data directories JBPM Relations e FileSystem persistence with VCS for Document repository For optimal performances e Linux 64 bits e PostgreSQL 8 4 Use PostgreSQL for document repository and all other services With Nuxeo 5 1 5 2 configure the document repository to externalize the blobs to filesystem Known working configurations OS e Debian GNU Linux 5 0 Lenny Linux Ubuntu 32 and 64 bits Edgy Eft 6 10 Feisty Fawn 7 04 Gutsy Gibon 7 10 Hardy Heron 8 04 LTS Intrepid Ibex 8 10 Jaunty Jackalope 9 04 Karmic Koala 9 10 Lucid Lynx 10 04 LTS Linux Mandriva 2008 1 Unix Mac OS X Tiger 10 4 Leopard 10 5 Snow Leopard 10 6 Ms Windows 2000 Windows 2003 server 32 and 64 bits Windows XP Windows 7 JVM e Sun JDK 1 5 e Sun JDK 6 recommended Storage backends Different backends may be set as well for Nuxeo Core repository as for all other Nuxeo services that persist data Here is a list of Known working backends PostgreSQL 8 2 8 3 and 8 4 MySQL 5 Oracle 10 MsSQL 2005 HSQL this is default Nuxeo 5 1 embedded database Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxe Nuxeo Enterprise Platform 5 3 Documentation Center e Derby this is the default Nuxeo 5 2 embedded database e H2 this is the default N
27. uxeo 5 3 embedded database LDAP e OpenLDAP e OpenDS e MS Active Directory Installing Nuxeo EP Once you have checked that you have the required version of Java installed on your computer you need to install Nuxeo EP Installing Nuxeo EP takes 3 steps 1 install the downloaded package 2 start the server 3 connect to the application in a browser Install Nuxeo EP ZIP package Just decompress it double click on the file or run unzip from the command line Start Nuxeo EP Nuxeo EP is distributed with a JBoss There are startup executables for each OS Linux Mac OS Solaris ct hl Dl NN NaN De De el el aD ND DD ae mmm m m m m m m m l l m 1 Launch a terminal and go to your installation directory 2 ae the scripts executable some ZIP tools loose the executable bit p T mm 22 2 Pes BB BB BB BE nnn m m On Mac OS X you can also use convenient commands from the Finder 1 Make the command scripts executable FD a lel el ND NE De ee ae ND el el aD lee ae ee mmmn M m Windows Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nmuxeo Nuxeo Enterprise Platform 5 3 Documentation Center P M m om eee eee 1 Open the file explorer and go to your installation directory 2 Click on NuxeoCtl exe then use the buttons in this Nuxeo control panel to start stop the server and show hide the logs
28. va 6 Recommendations Hardware configuration Nuxeo is designed to be scalable and thus to be deployed on many servers It can be installed on only one server for a start and can also easily be installed on many servers The constant is that there is the need to have one Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxeo Nuxeo Enterprise Platform 5 3 Documentation Center modern server with good performances Then the other servers can be more lower end So the numbers below are given for the one needed high end server e RAM 2Gb is the minimum requirement for using Nuxeo e CPU Intel Core2 or equivalent and better You might be better avoid machines from the Intel Pentium 4 Xeon series since some models have a too small amount of cache This impairs performance greatly compared to other CPU architecture of the same generation Intel Pentium 4 servers are quite widespread because of an attractive price politic e Storage disk space the minimum Nuxeo installation along with the needed JBoss and libs takes something between 200Mb and 250Mb on a filesystem Then the final size will of course depend on the amount of data that will be stored in Nuxeo A safe bet until we provide better numbers is to consider data space ratio of 1 5Gb to 2Gb Default configuration The default persistence configuration is lightweight and easy to
29. y Pee 22 22 2 Edit nuxeo conf with a text editor and set your preferences see Available Parameters for nuxeo conf 5 3 2 FD a Nell el ND NN De Ne De Del el Nal ae eae mmmn M M Some recommended changes are listed below 3 mun nuxeoctl giving the path to your nuxeo conf Pe ee ee ee mmmn m NUXEO CONF nuxeo conf bin nuxeoctl start ee ee eee eee eee ee ee ee ee ee M my 1 Using the file explorer move bin nuxeo conf to your desktop 2 Edit nuxeo conf with a text editor and set your preferences see Available Parameters for nuxeo conf 5 3 2 Some recommended changes are listed below Do not use Office writers neither Notepad Wordpad is fine Notepad and SciTE are good text editors there are a lot of other text editors 3 Run NuxeoCtl exe If NuxeoCtl exe doesn t find a nuxeo conf in the bin directory it will automatically look for it on the user desktop Recommended parameters changes Recommended changes are lt a a a a a a a a a a a a a a a a nuxeo bind address server_IP nuxeo notification eMailSubjectPrefix Nuxeo mail smtp host localhost mail smtp auth true mail smtp username anonymous mail smtp password password mail from noreply nuxeo com Or if you use a database template see below Advanced configuration with nuxeo conf and templates Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation
30. y with it in order to create your own template Best way is to create your own template directory outside Nuxeo directory as for nuxeo conf then reference it with its absolute path Available Parameters for nuxeo conf 5 3 2 Here is a list of available parameters for nuxeo conf This list may not be exhaustive but it will be often updated Those parameters can be either environment parameters used by Nuxeo runtime or template parameters used for values replacement in configuration files Parameter Default value separates Description default values for various templates JAVA_HOME None Path to Java home directory If undefined nuxeoctl script will try to discover it JAVA_OPTS Xms512m Xmx1024m Optional values passed to the JVM XX MaxPermSize 512m Nuxeo requires at least 1024 Mo in Dsun rmi dgc client gclnterval 360 JVM heap size and 256Mo as 0000 maximum permanent size 512 Dsun rmi dgc server gcinterval 36 recommended 00000 Decreasing garbage collector Dfile encoding UTF 8 frequency avoid having too much CPU usage Sun Java specific options recommended by JBoss NUXEO_HOME Parent directory of nuxeoctl Nuxeo home directory If any of the following variables exists it will be used JBOSS_HOME CATALINA_HOME JETTY_HOME Copyright 2010 2013 Nuxeo This documentation is published under Creative Common BY SA license More details on the Nuxeo Documentation License page nuxeo Nuxeo Enterprise Platform
Download Pdf Manuals
Related Search