Add System Import/Export

[ssddanbrown]

No description provided.

[davidtorcivia]

Adding support for this feature. The export ability for single pages is great, but being able to export an entire book or chapter to PDF/HTML/TXT (or even EPUB directly) would be fantastic and could really expand the usecases of the software.

[patoroco]

Related with #177 for export whole book.

Anyway, I would like a feature to bulk-import pages from... (in our case) github wiki pages (a bunch of markdown files)

[viewty]

Markdown export would be great if it's possible for that to be incorporated at some point?

[terxw]

Currently I am using md text files and I am testing bookstack, it would be awsome to import all files from directory as pages.

[Leon99]

Any chances for this to get done? Migration scenarios are currently not possible, which means that BookStack missing out on all those businesses around with existing wikis.

[brutecode]

.md import would be great as a starting point for migration. PDF export of shelves would also be great.

[edenpc]

+1 for importing .md

[Nebucatnetzer]

I agree, importing would be great. I'm currently importing a lot of notes by hand.
It's sort of a good thing since I have to go through all them but honestly if given the choice I would've just uploaded them. I converted them from org-mode to html with pandoc.
Works quite well when I paste the code directly into the source editor.

[Kazakhstanec94]

Good day guys.
Is it possible to import data from confluence? If so, how to do it

[oden08]

Is it possible to get an update on if an import is on the roadmap?

[ssddanbrown]

@oden08 Import is correctly not on the roadmap itself.

To be honest, "Import" as a feature request on its own is way too generic. The are many different formats or systems people will be looking to import from that we can't really just have a generic "Import" option. I initially opened this issue envisioning this to be a way to backup/restore a BookStack instance although I've had trouble seeing how we could achieve this as reliably as the current MySQL dump option.

On the roadmap is a REST API. For importing from other formats or systems, I imagine the best way forward will be for people to write scripts or applications to import into BookStack using the API. That way the BookStack project itself does not have to maintain a whole bunch of import logic.

That's how I see things moving forward.

[Leon99]

@ssddanbrown any chances for markdown import, being the most requested approach (which kind of makes sense, given that most wiki systems support it one way or another), implemented by you?

[bitinerant]

In the mean time, I'd be content hacking together my own import solution, but I get "Page not found" when I do the following:

• add shelves, books, chapters, pages, e.g.:

INSERT INTO `pages` VALUES (NULL,1,0,'title here','slug-here','<p id=\"bkmrk-text-here\">text here</p>','text here',5,'2019-06-04 15:55:55','2019-06-04 15:55:55',1,1,0,0,'text here',1)

• rebuild the search index - see docs and issue How to build search_terms table rows in mysql? #974

What else is needed?

[ssddanbrown]

@bitinerant Try running php artisan bookstack:regenerate-permissions. Think the permission index just needs to be updated.

[bitinerant]

Thank you, sir! That did it. :-)

[bitinerant]

Given the markdown, how can I generate the html and plain text to insert into the pages table, preferably from the command-line? Or, how can I refresh these 2 fields in the entire table? I've been searching all over for what should be really simple, but I don't know PHP or JavaScript.

[ssddanbrown]

@bitinerant Currently the markdown conversion to HTML is performed client side so there's no back-end systems to do this. You'd have to convert before sending in manually.

The conversion to plaintext is done at the following location:
https://github.com/BookStackApp/BookStack/blob/v0.26.2/app/Entities/Repos/PageRepo.php#L213-L217

The plaintext generation is not available via command-line or anything at this time.

[bitinerant]

Thanks a lot, Dan. I'll either write a script to do a null edit on every page from the client, or use something like Pandoc.

[wizofe]

@bitinerant Pandoc sounds like a great idea! How far are you with your mitigation/convertion script? As I am writing something similar and don't want to duplicate efforts :)

[bitinerant]

@wizofe - other projects preempted this, so I'm not too far yet. What wiki are you converting from and what language are you writing the conversion in? For me this is DokuWiki and Python.

So far I have several regular expressions to 'fix' Pandoc's incomplete DokuWiki support, the Pandoc conversion (markdown = pypandoc.convert(dokuwiki, format="dokuwiki", to="commonmark+pipe_tables+backtick_code_blocks", extra_args=["--atx-headers", "--wrap=none"])), and then several regular expressions to personalize the markdown. In the near future I hope to finish my regular expressions, generate html with Pandoc (should be trivial), and convert old revisions (history).

I'd be happy to coordinate on parts of the development if it makes sense.

[openmoto]

Hi guys,
I have a bookstack setup with one shelf per group I'm helping, after I complete the initial documentation for them and get a go ahead, I create their own bookstack server and manually copy their content page by page.

Is there no chance of having an export/import or migrate shelf to another bookstack instance feature?

[dimisjim]

@Kazakhstanec94 did you find a way to import from Confluence Server?

[GanizaniSitara]

Alas, no, and have pretty much given up on this. I think if we ever do migrate it will be to MediaWiki. On 16 Jan 2024, at 17:31, Dimitris Moraitidis ***@***.***> wrote:  @Kazakhstanec94<https://github.com/Kazakhstanec94> did you find a way to import from Confluence Server? — Reply to this email directly, view it on GitHub<#43 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AB4RHWSUBGKEBQHJYGRBZPLYO22PDAVCNFSM4BYRXNCKU5DIOJSWCZC7NNSXTN2JONZXKZKDN5WW2ZLOOQ5TCOBZGQYTSNZYGEYQ>. You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[ErikW-Farrow]

I would love to be able to have the ability to import documents. I am in the process of changing out our current standard (word documents) and want to get this into a proper KB, If we could mass import documents instead of having to Copy/Paste into the MD Editor that would make implementation of this a lot easier for me to bring to my team onboard.

[ssddanbrown]

I'm going to go ahead and close this off, since this scope/needs of this issue has never been super clear, some of the requests here have already been met, and since I've now built out and included some form of export/import format for the next feature release.

Here's a sneak preview if interested:

bookstack-portazips.mp4

And here's a full reference of the underlying format I've used for this:

https://github.com/BookStackApp/BookStack/blob/development/dev/docs/portable-zip-file-format.md

Other than that we have the API which provides a lot of access for custom import/export operations.

For any other requests/needs, more specific issues can be opened (if not already existing).
I will state up-front though that I wouldn't consider the import/export of other platforms within scope, but the API and new import/export format can help with that, and I'm happy to hear where improvements could be made to make that easier for developers where needed.