libreoffice-online/loolwsd
2015-04-21 15:51:28 +02:00
..
.gitignore Start on load testing 2015-03-26 17:04:08 +02:00
AUTHORS Autofooize 2015-03-09 11:19:00 +02:00
ChangeLog Autofooize 2015-03-09 11:19:00 +02:00
configure.ac Use separate child processes for LibreOfficeKit 2015-03-18 15:38:01 +02:00
Connect.cpp Set no receive timeout 2015-03-27 16:53:51 +02:00
COPYING Autofooize 2015-03-09 11:19:00 +02:00
INSTALL Autofooize 2015-03-09 11:19:00 +02:00
LoadTest.cpp More hacking 2015-03-27 18:25:06 +02:00
LoadTest.hpp Start on load testing 2015-03-26 17:04:08 +02:00
LOKitClient.cpp Some compilers seem very picky about ignoring return values 2015-04-10 12:51:42 +03:00
LOKitHelper.hpp Add a separate include file for some helper functions 2015-03-28 13:22:15 +02:00
LOOLProtocol.cpp Command type handler for selectText, selectGraphic, key, mouse 2015-04-13 20:42:44 +03:00
LOOLProtocol.hpp Start on load testing 2015-03-26 17:04:08 +02:00
LOOLSession.cpp Handle LOK_CALLBACK_STATE_CHANGED 2015-04-14 14:51:36 +03:00
LOOLSession.hpp Start on load testing 2015-03-26 17:04:08 +02:00
LOOLWSD.cpp loolwsd: Don't even start when the cache dir is not available. 2015-04-21 15:51:28 +02:00
LOOLWSD.hpp Make DEFAULT_PORT_NUMBER public 2015-03-26 17:04:08 +02:00
Makefile.am Add a new minimal non-GUI LOKit test program 2015-03-28 13:56:03 +02:00
NEWS Autofooize 2015-03-09 11:19:00 +02:00
protocol.txt A bit more info 2015-03-24 19:04:16 +02:00
README Reformatted loolwsd README. 2015-04-21 12:48:17 +02:00
TileCache.cpp Caller expects empty string as failure, not nullptr 2015-03-16 21:08:14 +02:00
TileCache.hpp Cache also document status 2015-03-13 14:17:51 +02:00
Util.cpp Adapt for older libpng 2015-04-10 12:39:12 +03:00
Util.hpp Adapt for older libpng 2015-04-10 12:39:12 +03:00

LibreOffice On-Line WebSocket server
====================================

Installation
------------

LibreOffice On-Line WebSocket server has the following dependencies:

* libpng
* Poco library: http://pocoproject.org/index.html.

Poco can be built with ./configure --prefix=/opt/poco && make install, but
distro packages exist too.

On openSUSE, you can use:

    zypper ar http://download.opensuse.org/repositories/devel:/libraries:/c_c++/openSUSE_13.2/devel:libraries:c_c++.repo
    zypper in poco

Building
--------

loolwsd uses autoconf/automake, so build using the usual:

    autoreconf
    automake --add-missing
    ./configure --enable-silent-rules --with-lokit-path=<...>/include
    make

where <...> is the location of the LibreOffice source tree.

If you have self-built Poco, add the following to ./configure:

    --with-poco-includes=<...>/include --with-poco-libs=<...>/lib

If you have the Poco debugging libraries (eg. you have a self-built Poco), you
can add --enable-debug to the configure options for additional debugging.

For Windows, a proper VS2013 project is needed.

There is still unconditional debugging output etc. This is a work in progress.

Running
-------

Run the loolwsd in the daemon mode:

    ./loolwsd --lopath=<...>/instdir/program

and connect loleaflet to that (see loleaflet/README for more info).

Again, <...> is location of the LibreOffice source tree with a built
LibreOffice.  This is work in progress, and consequently needs the latest
LibreOffice master.

For testing purposes, you can use the loolwsd testing mode:

    (echo load foo.odt; echo tile width=500 height=500 tileposx=0 tileposy=0 tilewidth=10000 tileheight=10000; sleep 10) |
        ./loolwsd --lopath=<...>/instdir/program --test

The handling of termination is a bit fragile, occasionally it dumps
core somewhere in LO code when quitting. Don't be scared, work in progress.

Protocol description
--------------------

See protocol.txt for a description of the protocol to be used over the
websocket.