Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[libreoffice online] add guide for LibreOffice Online #768

Closed
wants to merge 5 commits into from

Conversation

jorsn
Copy link
Contributor

@jorsn jorsn commented Sep 25, 2020

fixes #160

jorsn added 2 commits October 13, 2020 23:39
* it has no reliable licensing information (probably
  docker+libreoffice default, thus free)
* it requires a manual tweaks (remove `su`) in the startup script
@jorsn

This comment has been minimized.

@jorsn

This comment has been minimized.

@jorsn jorsn marked this pull request as ready for review November 5, 2020 10:08
@luto
Copy link
Member

luto commented Nov 5, 2020

Which "edit note" are you referring to?

@jorsn

This comment has been minimized.

Copy link
Member

@luto luto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your guide! While the actual app is quite easy to set up, the environment (udocker, WOPI, etc.) needs a little getting used to. While trying the guide I was a bit confused about the external dependencies and domains. I added a couple of comments that should help clear this up.

Commandline configuration
-------------------------

Now create a startup script ``$HOME/etc/libreoffice/run`` with the following content:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The etc/ directory is for config files. What do you think about placing the script int $HOME/bin/run_libreoffice?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put it there because it is wrapper containing configuration. Maybe I could put all config into the config file, even if some env vars are used in the official documentation.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you can get working without a wrapper script, that would be nice. Keep in mind that you can also set env vars using a supervisord environment= line. http://supervisord.org/configuration.html

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I can remove the config part from the wrapper script. I think it makes sense here to have a wrapper script and don't put any config in the supervisord file, because the udocker command requires quite some options and for debugging I found it helpful to be able to run the container unsupervised.


.. warning::

* Replace ``<dot-escaped-file-host-domain>`` by the domain of your file host
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please highlight the lines that need editing using emphasize-lines, as shown in the sphinx docs.

.. warning::

* Replace ``<dot-escaped-file-host-domain>`` by the domain of your file host
with escaped dots, e.g. ``cloud\.example\.org``. You can separate multiple
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the first time that cloud.example.org is mentioned in the guide, but it isn't introduced anywhere. Please add a paragraph at the beginning of the guide explaining:

  • you'll need a WOPI server, reachable at cloud.example.org in the example config
  • explain what the purpose of the WOPI/WebDAV server is (to store the actual files, they are not in your libreoffice uberspace)
  • the purpose of each domain: cloud.example.org (WOPI), isabell.uber.space (libreoffice web interface)

`LibreOffice Online <LOOL_>`_ is a free online office suite based on the
desktop office suite LibreOffice. It comprises a word processor, a spreadsheet
and a presentation software. For usage it must be integrated with a file host
which provides file access via WOPI or WebDAV, such as :lab:`Nextcloud
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add this information to a info box at the beginning of the guide. If I understand this right, in a production setup you'll need Nextcloud or Seafile to actually use this guide, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nextcloud, Seafile or any other WOPI or WebDAV host.

If you configured local file system storage, you can edit files *accessible in
the container* under the URL
https://isabell.uber.space/loleaflet/dist/loleaflet.html?file_path=file:///PATH/TO_DOC.
This is mainly intended for development and described in more detail in the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove all mentions of the local mode, as it's intended for development only.

@luto
Copy link
Member

luto commented Dec 18, 2020

closing this because of inactivity. we'd still be happy to include this, though!

@luto luto closed this Dec 18, 2020
@jorsn
Copy link
Contributor Author

jorsn commented Feb 17, 2021

Can you reopen the PR or must I create a new PR? I applied your feedback and simplified the config in jorsn/uberspace-lab@6ca67ce.

@luto
Copy link
Member

luto commented Feb 17, 2021

reopening doesn't seem to work because the master branch was since renamed to main. Please open a new one :)

@jorsn
Copy link
Contributor Author

jorsn commented Feb 17, 2021

It's now #932.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

instructions how to set up collabora office
2 participants