Changes between Version 7 and Version 8 of FactoryManual/Quickstart


Ignore:
Timestamp:
08/16/15 14:51:28 (3 years ago)
Author:
monkeyiq
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • FactoryManual/Quickstart

    v7 v8  
    33[FactoryManual << Previous: Factory Manual] | [../Setup Next: Setting up your account >>] 
    44 
    5 For the impatient, here follows a quick rundown of the steps that you need to do in order to run your own Officeshots factory. 
     5In August 2015 a new configure-backend.py script was added to the Officeshots factory repository. The configure-backend.py script allows you to sniff out installed office applications on your machine and setup the configuration file for you automatically. The below steps have been modified to cover the new configure-backend.py script with the longer hand configuration steps left at the end of the article for those who would prefer to perform all steps manually. 
     6 
     7The python code has been tested in 2015 using Python version 2.7.10. A recent 2.7.x Python should be the right choice for running the code. It might work with other python versions, but that has not been tested. On OSX and Linux the factory code uses the Python M2Crypto library. On Windows the native SSL implementation from Python is used. 
     8 
     9The initial steps such as initial account creation on officeshots and obtaining an SSL client certificate are the same for both procedures. These initial steps are not repeated: 
    610 
    711 1. Register for an account on the Officeshots website, activate your acount and let us know that you want to run a factory. 
    812    See [../Setup Setting up your account].[[br]][[br]] 
    913 2. Get an SSL client certificate if you do not have one yet. See [../Setup#CACert Get an SSL Certificate from CACert].[[br]][[br]] 
     14 
     15= Current method continues as... = 
     16 
     17The current method which uses the configure script introduced in July 2015 the steps then continue as: 
     18 
     19 3. Log in on the Officeshots website, create a new factory, give it a nice name. 
     20 
     21 4. Install the office applications you would like to use on your factory. Install helper applications if needed. For instance with Apache Open Office and !LibreOffice you need to ensure that you installed the Python UNO bridge with the office suite and have checked out unoconv. In addition to Python, Windows users need pywin32 installed for Word support and can find the UNO bridge when the choose Custom install when installing the application. Information specific to each application and platform is contained in the [https://gitlab.com/monkeyiq/officeshots/blob/master/trunk/factory/README]. 
     22 
     23 5. Download the latest Officeshots factory using git. While using git is the recommended method, you can also download a zip archive from the repository on gitlab. To checkout using git issue the command: 
     24    {{{ 
     25$> git clone https://gitlab.com/monkeyiq/officeshots.git 
     26    }}} 
     27  For the rest of the document we are interested in the directory from the git repository at trunk/factory. 
     28 
     29 6. Place your SSL client certificate from step 2 into a file called conf/cert.pem. 
     30 
     31 7. Change directory into ./src and execute configure-backend.py to sniff out your office applications. If you have downloaded programs or compiled things your self such as WebODF then manipulate the PATH environment variable such that the tools you have installed can be found in the PATH. The sniffing run will detect the full path to each program where it might be needed and use that full path in the configuration file. So you do not need to keep your PATH modified after running the sniff as shown below: 
     32    {{{ 
     33$> ./configure-backend.py --sniff 
     34}}}  
     35You can run this step multiple times if you need to adjust your PATH or you install new office applications that you would like detected. Changes that you make by hand to the backends configuration line and other lines in ../conf/config.ini will be overwritten if you run the --sniff phase again. 
     36 
     37 8. Have a look at your ../conf/config.ini file. The detected office applications are listed in the backends key of the global section. The cryptography library to use, log file location, and SSL client certificate location should have all been detected and set for you automatically by the sniffing phase. To tell the Officeshots server which applications your factory has configured you can use the --uploadconfig option to configure-backend.py. 
     38{{{ 
     39$> ./configure-backend.py --username=my-officeshots-email@example.com --password=foo --uploadconfig 
     40}}} 
     41You can run this step many times and duplicates of the same backend+version should not be created. 
     42 
     43 9. OPTIONAL: You can perform a local test of one or more of the backends that your factory will be offering. The --tool option selects which backend you want to use to perform the conversion. The -i specifies the input document path and the -o where you would like the result. If you use an odt extension then the output document will be in OpenDocumentFormat? if you use .pdf then you will get a PDF formatted result. 
     44{{{ 
     45$> ./factory.sh --tool=libreoffice5 -i /tmp/mydoc.odt -o /tmp/mydoc.pdf 
     46}}} 
     47 
     48 10. Start the factory. The below commands will start the factory on Linux, OSX, and Windows. The subsequent commands include command line options that you might also find useful. 
     49 
     50Linux or OSX: 
     51{{{ 
     52$> ./factory.py 
     53$> ./factory.py --debug 
     54}}} 
     55 
     56On Windows PowerShell. The skip-certificate-checks allows the factory to start even if there are issues reported by the Python SSL implementation for the server certificate. 
     57{{{ 
     58$> python ./factory.py  
     59$> python ./factory.py --skip-certificate-checks 
     60}}} 
     61    See also [../StandardFactory#Running Running the standard factory].  
     62 
     63= Older, manual installation steps = 
     64 
     65  These are the manual steps which were the method to setting things up prior to July 2015. 
     66 
    1067 3. Log in on the Officeshots website, create a new factory, give it a nice name and add application workers to it. Add separate applications within a suite (like !LibreOffice or Apache Open Office Calc, Impress and Writer) separately. See [../Setup#Configuration Configuring your factory]. [[br]][[br]] 
    1168 4. Install helper applications if needed. For instance with Apache Open Office and !LibreOffice you need Python and the Python UNO bridge. Windows users need Python 2.6 and can find the UNO bridge when the choose Custom install 
     
    3289on the [http://lists.opendocsociety.org/mailman/listinfo/officeshots Officeshots mailinglist]. 
    3390 
    34 Edited 2015. 
    35  
    3691[FactoryManual << Previous: Factory Manual] | [../Setup Next: Setting up your account >>]