Skip to content

Commit

Permalink
Adding headless doc (#807)
Browse files Browse the repository at this point in the history
* Adding doc

* Update doc/user/LIMITATIONS_AND_TROUBLESHOOTING.md

Co-authored-by: snoyer <[email protected]>

* Update doc/user/LIMITATIONS_AND_TROUBLESHOOTING.md

Co-authored-by: snoyer <[email protected]>

---------

Co-authored-by: snoyer <[email protected]>
  • Loading branch information
mwestphal and snoyer authored May 14, 2023
1 parent abca2cc commit 890e478
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 10 deletions.
2 changes: 1 addition & 1 deletion doc/user/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

## Alternatives

You can find other (older, smaller, checksum, RCs) release related packages and files on the [releases page](https://github.com/f3d-app/f3d/releases).
You can find other (headless, older, smaller, checksum, RCs) release related packages and files on the [releases page](https://github.com/f3d-app/f3d/releases).
You can also find there the [nightly release](https://github.com/f3d-app/f3d/releases/tag/nightly) to test the development version of F3D.
See the [desktop integration](DESKTOP_INTEGRATION.md) section in order actually integrate the binary release in your desktop.
Alternatively, you can build F3D yourself by following the [build](../dev/BUILD.md) guide.
Expand Down
13 changes: 4 additions & 9 deletions doc/user/LIMITATIONS_AND_TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,10 @@ With some C++ STD library version, explicit linking to `stdc++fs` is not support
* If no formats have working thumbnails, then it is an issue with the `f3d-plugin-xxx.thumbnailer` files.
* If only big file do not have thumbnails, this is intended, you can modify this behavior in the `thumbnail.d/10_global.json` configuration folder using the `max-size` option.

Some file managers (eg: Nautilus) are using sandboxing for thumbnails, which the F3D binary release does not support as it needs
access to the Xorg server for rendering anything.
A work around to this issue is to use a virtual Xorg server like Xephyr or Xvfb in all the `f3d-plugin-xxx.thumbnailer` files.
Here is how your `Exec` line should look to use `xvfb-run`. Keep in mind running xvfb can be very slow.

`Exec=xvfb-run f3d --dry-run -sta --no-background --output=%o --resolution=%s,%s %i`

Another workaround is to build VTK with EGL or osmesa support and then build F3D yourself against
this custom VTK build.
Some file managers (eg: Nautilus) are using sandboxing for thumbnails, which the F3D standard binary release does not support as it needs
access to the Xorg server to render anything.
In that case, you want to use the headless version of F3D that rely on EGL instead of Xorg, available in the [releases page](https://github.com/f3d-app/f3d/releases).
If you use the portable archive, make sure to extract it somewhere the sandboxing system has access to, eg: Nautilus uses `bwrap` and gives it access to `/usr` but not to `/opt`.

## Windows

Expand Down

0 comments on commit 890e478

Please sign in to comment.