ssddanbrown

{
  "info": {
    "name": "BookStack REST API",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": [
    {
      "name": "DOCS",
      "item": [
        {

ssddanbrown

Originally put together when submitting to laravelexamples.com

I'm not particularly proud of the code-base in terms of cleanliness and style, but I'm proud of where it's got to over the last 6 years. Over those years my experience, knowledge and opinions have changed; And the code-base can often reflect that as inconsistency.

• Custom Guard (Also LDAP support)

  • Guard Class: https://github.com/BookStackApp/BookStack/blob/05ef23d34e6346a1e4c05bc38eb7e5777180c514/app/Auth/Access/Guards/LdapSessionGuard.php
  • Registration in provider: https://github.com/BookStackApp/BookStack/blob/05ef23d34e6346a1e4c05bc38eb7e5777180c514/app/Providers/AuthServiceProvider.php

• External App Extension Support

• Allows a kind of wordpress-style extension of app logic, via a functions.php file in an out-of-app user theme folder.

ssddanbrown

<?php

use BookStack\Actions\Webhook;
use BookStack\Entities\Models\Page;
use BookStack\Facades\Theme;
use BookStack\Theming\ThemeEvents;


Theme::listen(ThemeEvents::WEBHOOK_CALL_BEFORE, function (string $event, Webhook $webhook, $detail) {

ssddanbrown

<?php

$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator(__DIR__));

/** @var SplFileInfo $file */
foreach ($iterator as $file) {
    $filePath = $file->getRealPath();
    if ($file->getFilename() === 'update.php' || $file->isDir()) continue;

    // Get controller file content and find validation rules

ssddanbrown

---
version: "2"
services:
  bookstack:
    image: lscr.io/linuxserver/bookstack
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - APP_URL=https://wiki.bookstackapp.com

ssddanbrown

<?php

use BookStack\Entities\Models\Page;
use BookStack\Theming\ThemeEvents;
use BookStack\Facades\Theme;
use Illuminate\Http\Request;

// This will be the content of the functions.php file you'll have
// after following the getting started instructions here:
// https://github.com/BookStackApp/BookStack/blob/release/dev/docs/logical-theme-system.md

ssddanbrown

// The BASE_URL of your BookStack instance, no trailing slash
const baseUrl = 'http://bookstack.local';


//////////////////
// USAGE EXAMPLE
///

// Get the export content for page ID 4

ssddanbrown

---
version: "2.1"
services:
  swag:
    image: ghcr.io/linuxserver/swag
    container_name: swag
    cap_add:
      - NET_ADMIN
    environment:
      - PUID=1000

ssddanbrown

#!/bin/bash
# BookStack backup & update script
# Forked from codemicro: https://gist.github.com/codemicro/f9dc94ecf5831772e1bff92dfba337d0

########### CONFIG ###########

# Configure this to be the location where BookStack is installed.
# Do not include a trailing slash
BOOKSTACK_DIR="/var/www/bookstack"

ssddanbrown

<?php

// Alter these to your instance, do not share publicly like this.
$base_api_url = 'http://bookstack.local/api/';
$token_id='ZNI62nNoghS3GyfzThlZFXqYNtHdHnM6';
$token_secret='zPffPZ1ATQcv4Nz75QYLEbMm6fPzmo7I';

// Id of the shelf we want to add our book to.
$shelfId = 12; // $_POST["category"]