Changes between Version 1 and Version 2 of FactoryManual/StandardFactory


Ignore:
Timestamp:
06/26/09 15:27:18 (8 years ago)
Author:
sander
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • FactoryManual/StandardFactory

    v1 v2  
    11= Factory Manual: Using the standard factory = 
     2 
     3[../Setup << Previous: Setting up your account] | [../NewBackends Next: Creating new backends >>] 
    24 
    35This chapter details the installation and configuration of the standard factory that is distributed by Officeshots.org. If you are implementing your own factory from scratch you can skip this chapter, but if you want to develop a factory builds on the standard factory then you want to read this so you understand how configuration works.  
     
    6567}}} 
    6668 
    67 If you do not want to use certain backends/sections then you only need to remove them from the ''backends'' line. You do not need to remove the entire sections. All the backends have at least a few configuration options in common.  
     69If you do not want to use certain backends/sections then you only need to remove them from the ''backends'' line. You do not need to remove the entire sections. All the backends have at least a few configuration options in common. 
     70 
     71 If you do not want to use certain backends/sections then you only need to remove them from the backends line. You do not need to remove the entire sections. All the backends have at least a few configuration options in common. 
     72 
     73 application:: 
     74    The name of the application. This must be the same as the application name configured on the website.  
     75 version:: 
     76    The version number of the application, such as "3.0" or "2003 SP2".  
     77 doctypes:: 
     78    A comma separated list of doctypes codes that the application can handle, such as odt, ods or odp. This must be a subset of 
     79    the doctypes that the application can handle according to the server. For example, OfficeReader can handle odt, ods and odp 
     80    files. You can skip processing of presentations by configuring the backend to only accept odt and ods files. 
     81    [[NoteBox(note, These are document type codes, not extensions. The document type codes are defined on the server. The odt code for example matches both odt (text) and ott (text template) files.)]] 
     82 formats:: 
     83    A comma separated list of format codes that the application can process such as png, pdf or odf.  
     84 backend:: 
     85    The name of the Python backend class that implements the worker. See the next section on which backends are available.  
     86 
     87Besides these standard configuration options each backend can have extra configuration options depending on the backend type. 
     88 
     89=== OOOServer === #OOOServer 
     90 
     91The OOOServer backends implements !OpenOffice.org running in headless mode. As such it is not able to produce screenshots but only ODF roundtrip and PDF export. To use the OOOServer backend you must have !OpenOffice.org running in headless mode. See [#OOOHeadless Running OpenOffice.org in headless mode]. 
     92 
     93Besides the standard configuration options, you can set the following options for the OOOServer backend. 
     94 
     95 ooo_host:: 
     96    The hostname of the machine that !OpenOffice.org is running on in headless mode. Normally this should be localhost. 
     97    If you set this option then you should also set the ooo_port option.  
     98 ooo_port:: 
     99    The port number that !OpenOffice.org is listening to. This should normally be 8100.  
     100 ooo_pipe:: 
     101    The name of the pipe that !OpenOffice.org is listening to. If you set this option then you should not set the ooo_host and ooo_port options. 
     102    [[NoteBox(note, On Windows XP and Vista it is not possible to connect to !OpenOffice.org using a socket with the ooo_host and ooo_port options. You should use a pipe instead.)]] 
     103 
     104==== Running !OpenOffice.org in headless mode ==== #OOOHeadless 
     105 
     106When !OpenOffice.org is running in headless mode you cannot start it yourself anymore. The easiest thing to do is to create a new user on your computer and run !OpenOffice.org in headless mode under that user account instead of your own. Linux users can start !OpenOffice.org in headless mode using the following command:  
     107 
     108{{{ 
     109$> soffice -headless -nologo -norestore -accept=socket,host=localhost,port=8100;urp;StarOffice.ServiceManager 
     110}}} 
     111 
     112For Windows users there is a simple batch file in the utils directory called utils/oooserver.bat. Simply edit that file, make sure that the OOOPATH is correct and that the OOOPIPE is the same as the pipe name in your configuration file. Then double-click the file to start !OpenOffice.org in headless mode. If you want to start !OpenOffice.org manually on Windows then you can execute the following command: 
     113 
     114{{{ 
     115$> soffice.exe -headless -nologo -norestore "-accept=pipe,name=officeshots;urp;StarOffice.ServiceManager" 
     116}}} 
     117 
     118[[NoteBox(note, Sometimes !OpenOffice.org on Windows does not install the Python UNO bridge. You can re-install !OpenOffice.org. Make sure you choose Custom install  amd check the box that installs Python UNO.)]] 
     119 
     120The oooserver init script in the utils directory can be used to automatically start and stop !OpenOffice.org in headless mode on a Debian or Ubuntu machine. It uses xvbf, the X Virtual !FrameBuffer so it can even run on a machine that has no complete X Server installed such as most servers. Place this file in your /etc/init.d directory and make it executable. Then you need to add symlinks to it in the appropriate places. You can execute the following command (as root) to create these symlinks automatically: 
     121 
     122{{{ 
     123#> update-rc.d oooserver defaults 
     124}}} 
     125 
     126You will also need to configure the oooserver init script. By default oooserver will run as user ''nobody''  but on many systems this user does not have a valid home directory. !OpenOffice.org does not start without a valid home directory. Either make sure user ''nobody'' exists and has a valid home directory, or change the USER parameter in the oooserver init script. 
     127 
     128=== CLI === 
     129 
     130[../Setup << Previous: Setting up your account] | [../NewBackends Next: Creating new backends >>]