BookStackApp / BookStack

A platform to create documentation/wiki content built with PHP & Laravel
https://www.bookstackapp.com/
MIT License
15.21k stars 1.9k forks source link

Refer to document in Paperless-NGX #4912

Open flemmingss opened 7 months ago

flemmingss commented 7 months ago

Describe the feature you'd like

I would like to easly refer to paperless-ngx documents in Bookstack. Example:

Car History

2023-07-24 - Bought car (_purchasecontract) 2024-01-04 - Replaced brake discs (receipt) 2024-03-017 - EU Test (receipt, _controlform)

Describe the benefits this would bring to existing BookStack users

My usecase might be marginal, but I use BookStack like a wiki for my life. Here I write down what is happening when it comes to car maintenance, House renovation, maintenance, overview of insurances and finances, computer home-lab info and so on. So Bookstack is where I write, and Paperless-NGX is where I store documents related to things happening.

I wish there was an easy way to refer to documents in Paperless-ngx

Can the goal of this request already be achieved via other means?

Documents can be uploaded to BookStack itself, but that goes against my goal here. I can also make share links to documents, but it is more time-consuming. image URL: https://domain.com/share/vLXXXRMYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX2lZHn

Have you searched for an existing open/closed issue?

How long have you been using BookStack?

1 to 5 years

Additional context

Might be possible with the API. But I am not technical enough to create this myself.

GET /api/share_links/
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 1,
    "next": null,
    "previous": null,
    "all": [
        3
    ],
    "results": [
        {
            "id": 3,
            "created": "2024-03-26T13:32:43.295144+01:00",
            "expiration": null,
            "slug": "vLXXXRMYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX2lZHn",
            "document": 159,
            "file_version": "original"
        }
    ]
}
ssddanbrown commented 7 months ago

Thanks for the request @flemmingss. To be honest, where possible I try to avoid adding the support & integration of external systems to our remit of maintenance, and therefore this kind of specific integration would be something I'd consider out of scope. I think it's better we focus on making integration interfaces/options available, for others to build/maintain where desired.

Since the paperless docs state "Full CRUD support" for the /api/share_links/ it looks like it should be possible though.

flemmingss commented 7 months ago

yeah, I see that philosophy. A better solution may be to have a way to load some custom scripts or something inside Bookstack. Or maybe this is something that can be done with userscripts on the browser.

Man-in-Black commented 7 months ago

If you have something that will work I would be happy if you can share it, I'm also interested in it.

ssddanbrown commented 7 months ago

A better solution may be to have a way to load some custom scripts or something inside Bookstack.

@flemmingss We do already provide a variety of ways to add custom scripts where needed: https://www.bookstackapp.com/docs/admin/hacking-bookstack/