[BookStack] Wiki Bookshelves System

BookStack for YunoHost

Integration level
Install BookStack with YunoHost

Overview

BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information. It is an opinionated wiki system that provides a pleasant and simple out of the box experience.

BookStack is built using PHP, on top of the Laravel framework and it uses MySQL to store data.

Shipped version: 0.31.4

Screenshots

Demo

Documentation

Links

6 Likes

Does it work? Is it safe to install? Is it still marked as low quality when I click “Install with Yunohost” and not listed in the web admin although here it is “Level 7” and “working”.

Anyway, thanks a lot for working with this. I was waiting for this app to be included

It should be good to go. The App library needs some time to upgrade the catalog apps

Thanks a lot. Works perfectly!

Small thing: Test Email failed, maybe because of the port used in the .env file. I changed it from 1025 (?) to standard 25 and the error message disappeared

This is updated in the next version :+1:t2:

Today’s update failed: “Unable to update core dependencies with Composer” was one of the error messages, see log here:
https://paste.yunohost.org/raw/azuwizuhen

Hello @ericg !
I have seen you recently packaged this interesting wiki. Thanks.
To be honest, I am a little bit lost between the diversity of existing wiki.

I am looking for a easy to use, quite good looking, and not to heavy on my small server. I have already used BookStack and I found it nice.
But I have also seen Yeswiki that seems quite nice.

Could you let me know how you choose BookStack ? Are you using it for your own wiki ? What make it suits you better ?
And finally, do you think you will maintain this package for some time ?

1 Like

Sorry, I left your message behind.
I don’t use BookStack myself, so I can’t advise you on this. You should try it out and see if it meets your needs. The package is maintained.

2 Likes

New stable version :tada:

  • 7 March 2021 - #16
    • Upgrade to upstream version 0.31.7
2 Likes

New stable version :tada:

  • 14 April 2021 - #16
    • Upgrade to upstream version 21.04 (new numbering system)

New stable version :tada:

  • 29 January 2022 - #38
    • Upgrade to upstream version 21.12.3
    • (partially) fix change_url script (we still have problems on multiple URL changes)
    • Now the app preserves images when updating
    • Update to PHP8
1 Like

Hello @ericg and thanks for updating this app.
I’d like to know, is LDAP supported for this app?
Indeed, I don’t see any mention of it on the repo’s GitHub and yet the native app supports it.

I struggle to implement LDAP authentication for this app…

If you set LDAP authentication out of the box, it works but LDAP users will only get reader role :dotted_line_face:

After talking to the BookStack developer here is the answer:

Does it mean that we must install the app as standard authentication method, set ‘Default user role option’ and then change the authentication method to LDAP?

  • Yeah, needs some action within BookStack by the original admin to get an admin LDAP user going.

the option is to set the authentication to standard, connect with the default credentials, set Default user role after registration option to Admin, switch to LDAP authentication method using config panel in the YunoHost webadmin, and connect the LDAP user (first one connecting should be granted the Admin role…)

You can ty this with this branch:

https://github.com/YunoHost-Apps/bookstack_ynh/tree/Admin

Edit: not very conclusive in my test however…

1 Like

Okay thanks, I’m going to try on my side right now.

BTW, configuring an app directly from YNH web admin panel is a new feature right? Otherwise i just have to edit .env in /var/www/bookstack

2nd edit: It’s working w/ your newest branch. I could successfully log in with two different YNH users to bookstack using LDAP auth. For the first login, they were automatically granted “admin” role as expected.

I guess you can add an explanation regarding how to make LDAP work and it should be fine. Thanks a bunch! :smiley:

The process to setup LDAP auth. admin user may get easier once we set an admin at install → [Feature Request]: Add "external_auth_id" option to the `bookstack:create-admin` command · Issue #3222 · BookStackApp/BookStack · GitHub

Edit. That was quick! a fix as been pubished: Release BookStack v21.12.4 · BookStackApp/BookStack · GitHub
It seems to work! and will be available soon.

1 Like

Thanks a lot for your help and willingness to improve Bookstack and Yunohost!
Having LDAP will greatly improve this app :wink:

1 February 2022 - #52

  • Upgrade to upstream version 21.12.4
  • Add config panel
  • Add LDAP support
    • LDAP authentication is used by default for fresh app install.
    • If you are upgrading BookStack, You may need extra steps to use LDAP authentication
      • In webadmin → bookstack → config panel set authentication to ldap
      • Set the user with the Admin role (must be a LDAP registered user):
        php8.0 artisan bookstack:create-admin --email="$email" --name="$admin" --external-auth-id="$admin"
1 Like

Hello,

Has anyone ever tried to attempt a restoration from another bookstack? I’m trying to do it myself right now but when I migrate the database, I am faced with an error 500 and don’t really have any logs to tell me more about the issue :confused:

It may be useful to look at the .env file to check if all the values are correct according to the new domain/path of your server. (cf. /var/www/bookstack/.env, the variable APP_URL ligne 22.

Edit. How did you migrate BookStack?