Commit 42160d8e authored by Jérome Perrin's avatar Jérome Perrin

README.rst: fix rst syntax

parent d9878156
Install Cloudooo Install Cloudooo
================ ================
::
$ python2.6 setup.py install $ python2.6 setup.py install
Warnings:
- you must have installed setuptools>=0.6c11 in this python. Warnings:
- you must have installed setuptools>=0.6c11 in this python.
Install LibreOffice / OpenOffice.org Install LibreOffice / OpenOffice.org
==================================== ====================================
Install LibreOffice or OpenOffice.org. Install LibreOffice or OpenOffice.org.
- http://www.libreoffice.org/download/ - http://www.libreoffice.org/download/
- http://download.openoffice.org/ - http://download.openoffice.org/
Create Configuration File Create Configuration File
========================= =========================
The configuration file is used to start the application using paster. The configuration file is used to start the application using paster.
::
$ cp ./cloudooo/sample/sample.conf . # Copy to current folder $ cp ./cloudooo/sample/sample.conf . # Copy to current folder
The next step is define some attributes in cloudooo.conf: The next step is define some attributes in cloudooo.conf:
- working_path - folder to run the application. This folder need be created. - working_path - folder to run the application. This folder need be created.
- uno_path - folder where UNO library is installed (ex. /opt/libreoffice/basis-link/program/) - uno_path - folder where UNO library is installed (ex. /opt/libreoffice/basis-link/program/)
- soffice_binary_path - folder where soffice.bin is installed (ex. /opt/libreoffice/program/) - soffice_binary_path - folder where soffice.bin is installed (ex. /opt/libreoffice/program/)
...@@ -27,59 +33,77 @@ Create Configuration File ...@@ -27,59 +33,77 @@ Create Configuration File
Run Application Run Application
=============== ===============
::
$ paster serve ./cloudooo.conf $ paster serve ./cloudooo.conf
or run as a daemon:
or run as a daemon:
::
$ paster serve ./cloudoo.conf --daemon $ paster serve ./cloudoo.conf --daemon
Stop Application Stop Application
================ ================
::
$ kill -1 PASTER_PID $ kill -1 PASTER_PID
Warning: always use SIGHUP because only with this signal all processes are Warning: always use SIGHUP because only with this signal all processes are stopped correctly.
stopped correctly.
Cloudooo Description Cloudooo Description
==================== ====================
- XMLRPC + WSGI will be one bridge for easy access to LibreOffice / OpenOffice.org. This will implement one XMLRPC server into WSGI (Paster). - XMLRPC + WSGI will be one bridge for easy access to LibreOffice / OpenOffice.org. This will implement one XMLRPC server into WSGI (Paster).
- PyUno is used to connect to LibreOffice / OpenOffice.org stated with open socket. The features will be handled all by pyuno. - PyUno is used to connect to LibreOffice / OpenOffice.org stated with open socket. The features will be handled all by pyuno.
- Only a process will have access to LibreOffice / OpenOffice.org by time. - Only a process will have access to LibreOffice / OpenOffice.org by time.
- All clients receive the same object(proxy) when connects with XMLRPC Server. - All clients receive the same object(proxy) when connects with XMLRPC Server.
Managing LibreOffice / OpenOffice.org process Managing LibreOffice / OpenOffice.org process
- start 'soffice.bin';
- Pyuno start 'soffice.bin' processes and the communication is through sockets; - start 'soffice.bin':
- 'soffice.bin' processes run in brackground;
- control 'soffice.bin'; - Pyuno start 'soffice.bin' processes and the communication is through sockets
- If the socket lose the connection, cloudooo kills the process, restartes processes and submit again the file;
- 'soffice.bin' processes run in brackground;
- control 'soffice.bin':
- If the socket lose the connection, cloudooo kills the process, restarts processes and submit again the file;
XMLRPC Server - XMLRPC + WSGI XMLRPC Server - XMLRPC + WSGI
----------------------------- -----------------------------
- Send document to 'soffice.bin' and return the document converted with metadata; - Send document to 'soffice.bin' and return the document converted with metadata
- XMLRPC receives a file and connects to 'soffice.bin' process by pyuno; - XMLRPC receives a file and connects to 'soffice.bin' process by pyuno;
- The pyuno opens a new document, write, add metadata and returns the document edited or converted to xmlrpc and it return the document to the user; - The pyuno opens a new document, write, add metadata and returns the document edited or converted to xmlrpc and it return the document to the user;
- When finalize the use of 'soffice.bin', should make sure that it was finalized; - When finalize the use of 'soffice.bin', should make sure that it was finalized;
- Export to another format; - Export to another format;
- Invite document and return metadata only; - Invite document and return metadata only;
- Edit metadata of the document; - Edit metadata of the document;
- Problems and possible solution - Problems and possible solutions
- 'soffice.bin' is stalled;
- finalize the process, start 'soffice.bin' and submit the document again(without restart the cloudooo); - 'soffice.bin' is stalled;
- 'soffice.bin' is crashed;
- finalize the process, verify if all the process was killed, start 'soffice.bin' and submit the document again(without restart the cloudooo) - finalize the process, start 'soffice.bin' and submit the document again (without restart the cloudooo);
- 'soffice.bin' received the document and stalled;
- if 'soffice.bin' isn't responding, kill the process and start - 'soffice.bin' is crashed;
- The document that was sent is corrupt;
- write in log the error and verify that the process aren't in memory - finalize the process, verify if all the process was killed, start 'soffice.bin' and submit the document again(without restart the cloudooo)
- 'soffice.bin' received the document and stalled;
- if 'soffice.bin' isn't responding, kill the process and start
- The document that was sent is corrupted;
- write in log the error and verify that the process aren't in memory
FFMPEGHandler FFMPEGHandler
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment