English (US)

Back up your Help Center articles at the click of a button!

Felix Stubner
  • Edited

Welcome

Let me introduce you to kBackup! This little app will allow you to back up your help centre content to your local hard drive at the click of a button. 

Using this app makes backing up your help centre content a breeze. 

Features

The app currently has a number of features and may be expanded to include additional features if the demand is there.

  • The app will back up your help centre content to a specified folder as HTML pages in the format of [ArticleId].html. The app will first verify that the user exists in the given Zendesk domain. This is included for security reasons, so only users who exist in the domain can back up the content.
  • The app will also back up any images that are embedded in your article and save these in the same backup folder.
  • The app will work for any Zendesk help centre, even if a custom domain is used.
  • Using the app to back up your help centre content is completely safe and will not affect any existing data. It will simply take a copy of it, so there is no possibility of data loss during the process.

Requirements

There are some requirements for using this app that need to be met in order for it to function correctly. I've included these requirements below:

  • Windows 7 or higher.
  • Microsoft.Net Framework 4.6 or higher. This version of the .NET Framework can be downloaded here.
  • SSO sign-in and 2FA are not supported. If these are used in your instance, please use the username and API token option instead of the username and password combination. For more info on generating an API token, see Zendesk's help article Generating a new API token.
  • If you choose to use a username and password combination, your user must have ‘Password Access’ to the API enabled in Zendesk. You can do this by going to Settings > Channels (Subsection) > API and enabling ‘Password Access’.

Getting Started

To get started with backing up your help centre content, ensure that you have met the requirements above, then go ahead and follow the steps below:

  1. Download the app here
  2. Extract the downloaded kBackup.zip file to your Desktop
  3. Right-click the app and select Run as administrator
  4. Enter your Zendesk domain into the Domain field
  5. Enter your Zendesk user email into the Email field
  6. Enter your Zendesk user password into the Password field. Alternatively, select the Use API Token checkbox to use an API token
  7. Select Connect
  8. Select the language you would like to back up from the Languages dropdown
  9. Select the Backup button
  10. Browse for a folder where you would like to back up your content and select Ok 


After selecting a folder and clicking Ok, the backup process will begin, and you will receive a notification when the backup is complete.

If you want to back up multiple languages, select another language from the Languages dropdown and click Backup again.

Download kBackup here!

Release Notes 

Release notes have been moved into ReleaseNotes.txt, which is now included in the download.

Giving Feedback & Reporting Bugs

For any feedback, feature and functionality requests or bugs you may have encountered, please leave a reply on this post or email me at felix.stubner(at)gmail(dot)com, and I will get back to you as soon as possible.

Leave a Review

If kBackup has helped you, please consider leaving a review on its Zendesk Marketplace Integration page. Additionally, feel free to click on the little up arrow on this post to upvote it. Thanks for your support!

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If kBackup has helped you, please consider up-voting this post by clicking the up arrow below. This will help other users to find the post more easily. Thank you!

233 Comments

  • Felix Stubner

    Hi Marc Spaeth,

    Thanks for reaching out. Backing up multiple languages is something I've made possible in a newer build that is not public yet. 

    Please reach out to me by email at felix(dot)stubner(at)gmail(dot)com and I'd be happy to share this with you. 

    0
  • Marc Spaeth

    Hi Felix,

    Thank you for sharing the new build.  To have the ability to backup multiple languages (We have 14 languages and about 600 articles) was exactly what I was looking for.  And is a life saver!

    0
  • iQmetrix
    • Edited

    When I start using the backup tool, it will back up about 20 articles before running into this error each time.  Is this an known issue that you are aware of?   I am using an Admin profile, running the app as an admin. 

    0
  • Katrina Greeves

    Felix Stubner We've received the same "Startindex" error as iQmetrix  We also have multiple languages to back up. Also running an Admin profile, with the app as an admin. Any ideas?

    0
  • Felix Stubner

    Hi Katrina Greeves thank you for reaching out, I have responded by email. 

    Apologies for missing your response iQmetrix. Please reach out to me by email and I'd be happy to share the updated build.

    0
  • Yannick D.

    Felix Stubner I also have the same issue, could you please help me with your latest release as well ?

    Thanks

    0
  • Felix Stubner
    • Edited

    Yannick D. thank you for reaching out. I have responded to your email.

    0
  • Cristian

    Hello,

    First and foremost excellent contribution that you have given us. It is what I need to be able to make the backup

    Second, I have the same problem as Michael




    How can I solve it?
    AND FROM ALREADY THANK YOU VERY MUCH

    0
  • Felix Stubner
    • Edited

    Hi Cristian, thanks for reaching out! I have not updated the version available here yet, but please reach out via email to felix(dot)stubner(at)gmail(dot)com I'd be happy to share it with you. Others have reported the new version to resolve their issues.

    0
  • Sila Erol

    Hi! It's a great app, thank you for that! I was able to back up the source content in Help Center but I cannot see the translations. I was wondering if we can possibly back up the translations as well? Thank you!

    0
  • Felix Stubner

    Hi Sila Erol, thank you for your message and for giving kBackup a try! I have a newer version of the app available, but it is still in beta phase at the moment. It supports authentication with an API token and also the ability to export multiple languages. Please feel free to reach out via felix(dot)stubner(at)gmail(dot)com and I'd be happy to share this version with you. I look forward to your message.

    0
  • Axel Weber

    Hi Felix, can you imagine why I can't use kbackup?
    The credentials we used are definitely correct. 

    0
  • Felix Stubner

    Axel Weber Thanks for reaching out! I'm afraid I don't know what could be the issue without further investigation. However, I have a newer version available that I can share via email (please feel free to reach out to me) which uses a combination of email and API Token to authenticate. This has proven effective for these types of issues and was developed as a workaround for users that used SSO. Alternatively, if you'd like to check back in a couple of days, I will be updating the download link to point to the latest version soon.

    1
  • LERIN Frédéric

    Felix Stubner

    Hello, thanks for the app. It works perfectly but It seems that only de Help Center linked to the main zendesk domain is backed up...
    How can I save the other Helpcenters, for all the different Brands I have ?

    Thanks for helping me

    0
  • Olivier Degardin

    Bonjour Frédéric.

    I guess you've got the same domain for the different brands.

    For example, if you've got 3 languages (English, Italian, French) for the Company TOTO, I guess your 3 URLs are similar to:

    • toto.zendesk.com/hc/en-us (or support.toto.com/hc/en-us)
    • toto.zendesk.com/hc/it 
    • toto.zendesk.com/hc/fr

    Then once connected to kBackup, just use the arrow linked to the field 'Languages' to watch the complete available languages and select the one you need (see attached screenshot for example if this the point you need).

    Regards,

    Olivier

    0
  • Felix Stubner

    Hi LERIN Frédéric, thank you for reaching out. I have updated the download links on the page, which should now reflect the latest version depicted by Olivier Degardin above (thank you for sharing a response!)

    Please go ahead and download the latest version and proceed as outlined by Olivier in the previous comment. If you run into any trouble, please feel free to reach out here again or contact me directly via my email felix.stubner(at)gmail(dot)com.

    1
  • Community Services Volunteer

    Looks like we're in the same boat with the backup not grabbing all of the articles from either of our brands.  We have 160 and it's grabbing 59 of them in both cases. 

    What can we do to get all of the articles?  I'm not getting an error.  It says complete but it isnt.

    Thanks!

    0
  • Felix Stubner

    Community Services Volunteer thanks for reaching out! I've replied to your email.

    0
  • Thanursan

    Thanks Felix Stubner for the app!
    I made a Youtube tutorial on how to use it if anyone needs some help.

    1
  • Felix Stubner

    Thanursan that's fantastic! Thank you so much for taking the time to make this 🤗

    1
  • Dung Nguyen

    Hi Felix Stubner
    Thank you so much for the tool.

    However, can you please help with the truncated title? I can't determine if the article names are like this

    0
  • Felix Stubner

    Hi Dung Nguyen, thank you for reaching out! The title is truncated in the file name as they can be variable lengths and sometimes result in issues with the file path length. Because of this, the article ID is included in brackets. The title of the article is also included within the saved file itself. I hope this helps to clarify the behaviour. Please let me know if you have any further questions.

    0
  • Dung Nguyen

    Hi Felix Stubner

    Thank you for getting back to me!

    Could you please help to increase the number of characters by just 5 or 10? It would help me a lot in my case. Really appreciate your help on this.

    0

Please sign in to leave a comment.

Didn't find what you were looking for?

New post
Powered by Zendesk