Skip to main content

my bookstack setup

This site is built using bookstack, which is great documentation software. I've modified the default bootstack setup quite a bit to get away from the shelf/book/chapter/page metaphor and have sort of replaced it with my own area/section/topic/page metaphor, just to make the organization a little more generic, and cms/wiki-like. 

The total changes I've made are really kind of minimal and are outlined below: 

created new theme folder called robertvigil.com under /var/www/bookstack/themes folder

copied /var/www/bookstack/resources/lang/en/entities.php to /var/www/bookstack/themes/robertvigil.comlang/end/entities.php and changed hieararchy terms/references as follows (for all upper/lower case and plural/singular forms): "shelf" -> "area", "book" -> "section", "chapter" -> "topic", (left "page" as "page")

copied /var/www/bookstack/resources/lang/en/activities.php to /var/www/bookstack/themes/robertvigil.com/lang/end/activities.php and applied same hieararchy terms/references changes as entites.php

copied /var/www/bookstack/resources/views/pages/page-display.blade.php to /var/www/bookstack/resources/lang/en/activities.php to /var/www/bookstack/themes/robertvigil.com/pages/page-display.blade.php, and commented out this line in order to, by default, not show the big page title at top of any pages:

<div dir="auto">

    <!--<h1 class="break-text" id="bkmrk-page-title">{{$page->name}}</h1>-->

    <div style="clear:left;"></div>

    @if (isset($diff) && $diff)
        {!! $diff !!}
    @else
        {!! isset($page->renderedHTML) ? $page->renderedHTML : $page->html !!}
    @endif
</div>

added these lines to root .env file:

APP_THEME=robertvigil.com
STORAGE_TYPE=local_secure_restricted # more fine-grained permissions control, including for images, at the expense of some performance

changed role security for public role by removing all but ..

Bookstack is really well designed, and the overall organization and permissions systems are really well thought out. It is however intended to be used for documentation purposes, hence the book metaphor used throughout. Because of how much functionality out of the box it provides, I was perfectly happy to take bookstack as is and modify it for my own purposes, and am happy with the results. 

backing up bookstack

At least for my setup, the following items need to be backed up:

  • the overall db
  • the theme files that I created to override some of the base look/functionality
  • any image/media assets

Back to top