Full PDF Wrapper #1036

Open
opened 2026-02-04 23:31:19 +03:00 by OVERLORD · 27 comments
Owner

Originally created by @recklessnl on GitHub (Feb 9, 2019).

Describe the feature you'd like
Bookstack is a Wiki-like app, a perfect place to store manuals. A ton of manuals on the internet are stored as PDFs. It would be so much easier if Bookstack had native PDF Wrapper support enabled for users to instantly load the PDF file within the Bookstack page.

Describe the benefits this feature would bring to BookStack users
Pretty self-explanatory, it makes Bookstack even more useable for small businesses or families.

Additional context
Currently you can only download PDFs to your PC. There are other docker apps like Grocy who have full PDF wrapper support and it really makes it so much easier. Really hope this can get added.

Originally created by @recklessnl on GitHub (Feb 9, 2019). **Describe the feature you'd like** Bookstack is a Wiki-like app, a perfect place to store manuals. A ton of manuals on the internet are stored as PDFs. It would be so much easier if Bookstack had native PDF Wrapper support enabled for users to instantly load the PDF file within the Bookstack page. **Describe the benefits this feature would bring to BookStack users** Pretty self-explanatory, it makes Bookstack even more useable for small businesses or families. **Additional context** Currently you can only download PDFs to your PC. There are other docker apps like Grocy who have full PDF wrapper support and it really makes it so much easier. Really hope this can get added.
OVERLORD added the 🔨 Feature Request label 2026-02-04 23:31:19 +03:00
Author
Owner

@ssddanbrown commented on GitHub (Feb 13, 2019):

Hi @recklessnl,
Thanks for the request.

This seems very similar to #705, Do you see this issue as different to that one or can I close this as a duplicate?

@ssddanbrown commented on GitHub (Feb 13, 2019): Hi @recklessnl, Thanks for the request. This seems very similar to #705, Do you see this issue as different to that one or can I close this as a duplicate?
Author
Owner

@recklessnl commented on GitHub (Feb 14, 2019):

It's different, because we shouldn't want a 'preview', we should have a full wrapper that enables users to directly 'stream' the PDF file in question. This way you can embed the PDFs directly into the overall Bookstack page, alongside all the other tools you are currently have implemented. It's not so much a preview as a fully functioning PDF embed / wrapper. I can't think of any downside to this.

@recklessnl commented on GitHub (Feb 14, 2019): It's different, because we shouldn't want a 'preview', we should have a full wrapper that enables users to directly 'stream' the PDF file in question. This way you can embed the PDFs directly into the overall Bookstack page, alongside all the other tools you are currently have implemented. It's not so much a preview as a fully functioning PDF embed / wrapper. I can't think of any downside to this.
Author
Owner

@ssddanbrown commented on GitHub (Feb 14, 2019):

Ah, Okay, Thanks for confirming the difference.

I can't think of any downside to this.

  • Web PDF renders can have varying and heavy performance due to the complexities in rendering PDFS.
  • Web PDF renders can often have quirks and not fully support all features of a PDF.
  • This would be extra functionality to implement & maintain, Especially if built into the editors, Using up more maintainer time.
  • This could encorouge users leaving content in PDF format, instead of page content, where it becomes much harder for BookStack to index for search/discovery and revision tracking.
@ssddanbrown commented on GitHub (Feb 14, 2019): Ah, Okay, Thanks for confirming the difference. > I can't think of any downside to this. - Web PDF renders can have varying and heavy performance due to the complexities in rendering PDFS. - Web PDF renders can often have quirks and not fully support all features of a PDF. - This would be extra functionality to implement & maintain, Especially if built into the editors, Using up more maintainer time. - This could encorouge users leaving content in PDF format, instead of page content, where it becomes much harder for BookStack to index for search/discovery and revision tracking.
Author
Owner

@recklessnl commented on GitHub (Feb 14, 2019):

  1. A PDF wrapper is optional feature users can add to their pages. If it doesn't perform up to standard, they can use the current system.
  2. Same as above, although I have to say I love the one Grocy is using. Works fine for my needs. The point isn't to have a fully functional PDF editor anyway, it should be for reading.
  3. Can't comment on this, all I can say is it would make bookstack a lot better and more useable
  4. So what? More power to the users. I want some pages to be just one big PDF manual page. Who are you to tell me how to use it? Again, you don't HAVE to use it if you don't want it. Besides, copying a full PDF manual to pictures or a format that bookstack can read is tedious as ****. Much better to just have a PDF reader / wrapper and make it easy for everyone.

Must have feature for me.

@recklessnl commented on GitHub (Feb 14, 2019): 1) A PDF wrapper is optional feature users can add to their pages. If it doesn't perform up to standard, they can use the current system. 2) Same as above, although I have to say I love the one Grocy is using. Works fine for my needs. The point isn't to have a fully functional PDF editor anyway, it should be for reading. 3) Can't comment on this, all I can say is it would make bookstack a lot better and more useable 4) So what? More power to the users. I want some pages to be just one big PDF manual page. Who are you to tell me how to use it? Again, you don't HAVE to use it if you don't want it. Besides, copying a full PDF manual to pictures or a format that bookstack can read is tedious as ****. Much better to just have a PDF reader / wrapper and make it easy for everyone. Must have feature for me.
Author
Owner

@ssddanbrown commented on GitHub (Feb 16, 2019):

4. So what? More power to the users. I want some pages to be just one big PDF manual page. Who are you to tell me how to use it? Again, you don't HAVE to use it if you don't want it.

This may be the case for your usage but it's not always up to users how they are supposed to use the system. We have to consider the wider view of how BookStack may be used. In a lot of instances BookStack would have been implemented to ensure documentation is standardised and indexed but adding this would work against that.

Must have feature for me.

It looks like some users have had luck implementing something similar to what you're asking for in #705 otherwise it may be a while before something like this is officially supported.

@ssddanbrown commented on GitHub (Feb 16, 2019): > 4\. So what? More power to the users. I want some pages to be just one big PDF manual page. Who are you to tell me how to use it? Again, you don't HAVE to use it if you don't want it. This may be the case for your usage but it's not always up to users how they are supposed to use the system. We have to consider the wider view of how BookStack may be used. In a lot of instances BookStack would have been implemented to ensure documentation is standardised and indexed but adding this would work against that. > Must have feature for me. It looks like some users have had luck implementing something similar to what you're asking for in #705 otherwise it may be a while before something like this is officially supported.
Author
Owner

@danielsagostinho commented on GitHub (Oct 24, 2019):

Actually, I was searching for something like this. Before your app, I've done manuals and converted them to PDF, would be nice to import material that is already done, and not do it again in the editor.

The attachment doesn't really "work", since most people see a blank page and don't check the attachments.

@danielsagostinho commented on GitHub (Oct 24, 2019): Actually, I was searching for something like this. Before your app, I've done manuals and converted them to PDF, would be nice to import material that is already done, and not do it again in the editor. The attachment doesn't really "work", since most people see a blank page and don't check the attachments.
Author
Owner

@xthursdayx commented on GitHub (Jan 18, 2020):

I love Bookstack in general, but I am also desperate to see this feature added. In my use case, 99% of my entries will still be standard Bookstack markdown pages, but I would like to be able to host, link to, and view pdf hardware manuals from within my books.

@xthursdayx commented on GitHub (Jan 18, 2020): I love Bookstack in general, but I am also desperate to see this feature added. In my use case, 99% of my entries will still be standard Bookstack markdown pages, but I would like to be able to host, link to, and view pdf hardware manuals from within my books.
Author
Owner

@recklessnl commented on GitHub (Feb 28, 2020):

Ping @ssddanbrown any update on this?

@recklessnl commented on GitHub (Feb 28, 2020): Ping @ssddanbrown any update on this?
Author
Owner

@ssddanbrown commented on GitHub (Mar 3, 2020):

@recklessnl No, not at this time.

@ssddanbrown commented on GitHub (Mar 3, 2020): @recklessnl No, not at this time.
Author
Owner

@sargrvb commented on GitHub (Sep 25, 2020):

I'm also looking for a PDF cloud viewer of sorts. I love using Home Assistant and have been trying to integrate Grocy into my flow. Using something more specific like BookStack or Calibre seems ideal though. Please reconsider adding this feature some time in the future.

@sargrvb commented on GitHub (Sep 25, 2020): I'm also looking for a PDF cloud viewer of sorts. I love using Home Assistant and have been trying to integrate Grocy into my flow. Using something more specific like BookStack or Calibre seems ideal though. Please reconsider adding this feature some time in the future.
Author
Owner

@Wookbert commented on GitHub (Feb 23, 2021):

+1 for inline PDF viewing.

Same approach here: Aggregating the (PDF) manuals for all household appliances etc. we own in BookStack.

@Wookbert commented on GitHub (Feb 23, 2021): +1 for inline PDF viewing. Same approach here: Aggregating the (PDF) manuals for all household appliances etc. we own in BookStack.
Author
Owner

@TheTwist76 commented on GitHub (Mar 8, 2021):

+1

@TheTwist76 commented on GitHub (Mar 8, 2021): +1
Author
Owner

@seventinth commented on GitHub (Apr 14, 2021):

+1 for the new month. surprised this isn't already built in.

@seventinth commented on GitHub (Apr 14, 2021): +1 for the new month. surprised this isn't already built in.
Author
Owner

@sprklinginfo commented on GitHub (May 12, 2021):

I'd like this feature as well. It is annoying to have to download the pdf file in order to view it. Inspired by the information in a similar request, here is my workaround to solve this issue before any official supports released. Please see my comment here: https://github.com/BookStackApp/BookStack/issues/705#issuecomment-840079563

@sprklinginfo commented on GitHub (May 12, 2021): I'd like this feature as well. It is annoying to have to download the pdf file in order to view it. Inspired by the information in a similar request, here is my workaround to solve this issue before any official supports released. Please see my comment here: https://github.com/BookStackApp/BookStack/issues/705#issuecomment-840079563
Author
Owner

@ssddanbrown commented on GitHub (Jun 13, 2021):

Just a note on this, Within BookStack v21.05.2 it's now possible to open up attachments in an "inline" (Not forced download) via Ctrl+Click of the attachment (Or Cmd+click on Mac). Alternatively, an attachment link of this type can be manually formed by adding an ?open=true query parameter to the link.

The above may make it easier to implement workarounds to achieve embedding. You can kind of get something going by using one of these "inline" links within an iframe, added via the "media" button of the WYSIWYG editor. You might need to get some custom styles going though to control iframe sizing.

@ssddanbrown commented on GitHub (Jun 13, 2021): Just a note on this, Within BookStack [v21.05.2](https://github.com/BookStackApp/BookStack/releases/tag/v21.05.2) it's now possible to open up attachments in an "inline" (Not forced download) via Ctrl+Click of the attachment (Or Cmd+click on Mac). Alternatively, an attachment link of this type can be manually formed by adding an `?open=true` query parameter to the link. The above may make it easier to implement workarounds to achieve embedding. You can kind of get something going by using one of these "inline" links within an iframe, added via the "media" button of the WYSIWYG editor. You might need to get some custom styles going though to control iframe sizing.
Author
Owner

@lewisstancer commented on GitHub (Dec 21, 2021):

+1. I would be quite happy with just a PDF viewer with a customisable fixed height.

I can use HTML embed code like this to place a viewer into a custom HTML page but this doesn't appear to work on BookStack

<embed src="https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf" type="application/pdf" width="100%" height="500px" />

@lewisstancer commented on GitHub (Dec 21, 2021): +1. I would be quite happy with just a PDF viewer with a customisable fixed height. I can use HTML embed code like this to place a viewer into a custom HTML page but this doesn't appear to work on BookStack `<embed src="https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf" type="application/pdf" width="100%" height="500px" />`
Author
Owner

@lewisstancer commented on GitHub (Dec 21, 2021):

I have a way to do this on my own system. You upload the attachment and then use the embed code I pasted above. Change the URL to the URL of the uploaded attachment, add ?open=true to the end and voila! Seems to work without any issue

@lewisstancer commented on GitHub (Dec 21, 2021): I have a way to do this on my own system. You upload the attachment and then use the embed code I pasted above. Change the URL to the URL of the uploaded attachment, add `?open=true` to the end and voila! Seems to work without any issue
Author
Owner

@ssddanbrown commented on GitHub (Dec 21, 2021):

@lewisstancer If you hold down Ctrl when clicking the attachment you'll get the link without having to manually append the query string yourself.

@ssddanbrown commented on GitHub (Dec 21, 2021): @lewisstancer If you hold down `Ctrl` when clicking the attachment you'll get the link without having to manually append the query string yourself.
Author
Owner

@alabastrowa commented on GitHub (Jan 6, 2022):

I just started using the bookstack. Unfortunately, the method described above with displaying pdf after pressing ctrl does not work. Am I doing something wrong or do I need to change something? All I can do is download the file.

@alabastrowa commented on GitHub (Jan 6, 2022): I just started using the bookstack. Unfortunately, the method described above with displaying pdf after pressing ctrl does not work. Am I doing something wrong or do I need to change something? All I can do is download the file.
Author
Owner

@ChristophTek commented on GitHub (Feb 15, 2022):

I am also +1 for this, My line of work we have many manuals which for ease of storage would be great on Bookstack. We have the compute power so that's not a concern. I would agree with @recklessnl it should be an opt-in function.

@ChristophTek commented on GitHub (Feb 15, 2022): I am also +1 for this, My line of work we have many manuals which for ease of storage would be great on Bookstack. We have the compute power so that's not a concern. I would agree with @recklessnl it should be an opt-in function.
Author
Owner

@zeus1999 commented on GitHub (Jun 29, 2022):

+1 it would be an very helpfull feature for me

works good, but its not possible for an dynamic height or an 100% height for the file

@zeus1999 commented on GitHub (Jun 29, 2022): +1 it would be an very helpfull feature for me <embed src="https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf" type="application/pdf" width="100%" height="500px" /> works good, but its not possible for an dynamic height or an 100% height for the file
Author
Owner

@dockrbyter commented on GitHub (Jul 6, 2022):

+1

@dockrbyter commented on GitHub (Jul 6, 2022): +1
Author
Owner

@FlimFlam commented on GitHub (May 20, 2023):

+1

@FlimFlam commented on GitHub (May 20, 2023): +1
Author
Owner

@homeztead commented on GitHub (Feb 20, 2024):

+++++ 1
Please make it easier for us non-tech savvy users....
BookStack is truly a great product and this would elevate it to be closer to Supreme status.
Thank you for what you do.

@homeztead commented on GitHub (Feb 20, 2024): +++++ 1 Please make it easier for us non-tech savvy users.... BookStack is truly a great product and this would elevate it to be closer to Supreme status. Thank you for what you do.
Author
Owner

@biziosan commented on GitHub (May 22, 2024):

+++++1
I just discovered Bookstack, and I love it. Thank you for your hard work! However, the thing that is stopping us from adopting it is the lack of an integrated PDF viewer. Since PDF is everywhere and will not go away any time soon, I was expecting it to be a very basic feature. Also, Mozilla has implemented it for you. There is no need to maintain it. Please make this feature available!!!

@biziosan commented on GitHub (May 22, 2024): +++++1 I just discovered Bookstack, and I love it. Thank you for your hard work! However, the thing that is stopping us from adopting it is the lack of an integrated PDF viewer. Since PDF is everywhere and will not go away any time soon, I was expecting it to be a very basic feature. Also, Mozilla has implemented it for you. There is no need to maintain it. Please make this feature available!!!
Author
Owner

@digital-grease commented on GitHub (Nov 21, 2024):

+1

@digital-grease commented on GitHub (Nov 21, 2024): +1
Author
Owner

@nikhomekgn commented on GitHub (Dec 27, 2025):

+1

@nikhomekgn commented on GitHub (Dec 27, 2025): +1
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#1036