Bug 1161 - Install userguide at server installation.
Summary: Install userguide at server installation.
Status: CLOSED FIXED
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: PC Linux
: P2 Enhancement
Target Milestone: 4.15.0
Assignee: Pierre Ossman
URL:
Keywords: relnotes, wilsj_tester
Depends on:
Blocks: 3964
  Show dependency treegraph
 
Reported: 2005-03-08 13:18 CET by Erik Forsberg
Modified: 2023-02-28 12:26 CET (History)
1 user (show)

See Also:
Acceptance Criteria:
* the administrator's guide should be included in the server package * the license documents should be included in the server package


Attachments

Description Erik Forsberg cendio 2005-03-08 13:18:55 CET
We should install the userguide under
/opt/thinlinc/share/doc/thinlinc-server/userguide at server installation.

As a bonus option, tl-setup could have a choice for adding a apache
configuration file to make the documentation accessible via http.
Comment 1 Peter Åstrand cendio 2008-04-02 10:33:41 CEST
This bug goes fine with 1889. Having the docs available under /opt/thinlinc is useful even for us; I commonly need to go to www.cendio.com when installing at customers. 

Exporting the documentation via Apache is not very interesting, IMHO, since most machines can reach www.cendio.com anyway. 
Comment 2 Pierre Ossman cendio 2021-10-28 08:58:11 CEST
The documentation could be accessed using tlwebadm as we have a documentation section there.

It would also be useful to include the license texts there, or in the TAG itself.
Comment 3 Pierre Ossman cendio 2022-02-10 13:54:48 CET
Solving this might require solving bug 4885 first, as we likely don't want to add yet another RPM to include the documentation.

It might also be possible to do something hacky in tlmisc to include things there.
Comment 11 Pierre Ossman cendio 2022-03-09 11:13:30 CET
Works well now.

> * the administrator's guide should be included in the server package
> 
> * the license documents should be included in the server package

Yup. I can see this after installing the rpm:

> $ ls /opt/thinlinc/share/doc/thinlinc-server/
> EULA.txt  html  open_source_licenses.txt

I also tested opening the html version in Firefox and doing some searches. All works great!
Comment 12 William Sjöblom cendio 2022-03-14 11:03:35 CET
I have tested the newly introduced documentation using server build #2506 on Ubuntu 20.04 and Fedora 35:

• ☑ Release notes look good
• ☑ License texts are shipped
  • ☑ Same files in `server-bundle/doc/adminguide/html' and
    `/opt/thinlinc/share/doc/thinlinc-server/html' for both debs 
    and rpms.
• ☑ License texts are shipped
• ☐ Documentation has sane permissions


Acceptance criteria:
• ☑ The administrator's guide should be included in the server package
• ☑ The license documents should be included in the server package

The minor flaw I found was related to the file permissions of the documentation. Overall, these are fine (world-readable) with the minor problem that the EULA and open-source licenses have their execute bit set. With this minor issue fixed, this bug should be ready to be closed.
Comment 13 William Sjöblom cendio 2022-03-14 11:05:33 CET
(In reply to William Sjöblom from comment #12)
>-• ☑ License texts are shipped
>+• ☑ Documentation is shipped
>   • ☑ Same files in `server-bundle/doc/adminguide/html' and
>     `/opt/thinlinc/share/doc/thinlinc-server/html' for both debs 
>     and rpms.
Comment 15 Pierre Ossman cendio 2022-03-15 10:11:58 CET
(In reply to William Sjöblom from comment #12)
> 
> The minor flaw I found was related to the file permissions of the
> documentation. Overall, these are fine (world-readable) with the minor
> problem that the EULA and open-source licenses have their execute bit set.
> With this minor issue fixed, this bug should be ready to be closed.

Apparently "install" defaults to 0755 for files. Fixed now.
Comment 16 William Sjöblom cendio 2022-03-16 15:43:36 CET
Permissions look good in server build #2512. Marking as closed.

Note You need to log in before you can comment on or make changes to this bug.