View source for Bookstack

[https://www.bookstackapp.com/ BookStack] is a platform for organising and storing information.

== Installation ==
To install BookStack, add the following to your NixOS configuration:<syntaxhighlight lang="nixos">
services.bookstack.enable = true;
</syntaxhighlight>[https://search.nixos.org/options?channel=unstable&query=services.bookstack More options] are available.

== Configuration ==
BookStack uses a MySQL (MariaDB) as a DBMS, the service provides an option to create the necessary database with the necessary permissions:<syntaxhighlight lang="nixos">
services.bookstack.database.createLocally = true; # False by default
</syntaxhighlight>BookStack needs to know the domain on which it runs:<syntaxhighlight lang="nixos">
services.bookstack.hostname = "kb.example.com";
</syntaxhighlight>BookStack requires an app secret, primarily used for encryption. You can generate a valid app key using the following command:<syntaxhighlight lang="bash">
echo base64:$(nix run nixpkgs#openssl -- rand -base64 32)

</syntaxhighlight>Write this value to a file owned by the <code>bookstack</code> user in the <code>bookstack</code> group, perhaps using a secret manager such as [[Agenix]], and provide its path to Bookstack:<syntaxhighlight lang="nixos">
services.bookstack.appKeyFile = "path-to-your-secret";

</syntaxhighlight>And using [[Agenix]],<syntaxhighlight lang="nixos">
services.bookstack.appKeyFile = config.age.secrets.bookstack-appkey.path;
</syntaxhighlight>To go further, it is useful to know that BookStack uses Laravel. So, for example, to use S3 instead of the local filesystem, check Laravel's documentation on file storage and the service definition. 

== Tips and tricks ==

=== Changing the default port Nginx listens on ===
<syntaxhighlight lang="nixos">
services.bookstack.nginx.listen = [
 { addr = "[::]"; port = 8080; ssl = false;}
 { addr = "0.0.0.0"; port = 8080; ssl = false;}
 { addr = "[::]"; port = 8443; ssl = true;}
 { addr = "0.0.0.0"; port = 8443; ssl = true;}
]
</syntaxhighlight>

== Troubleshooting ==

=== "No such file or directory" in bookstack-setup ===
You need to connect Bookstack to a MySQL database, the service definition can install and configure one on your system with <code>services.bookstack.database.createLocally = true;</code>, otherwise you need to configure it yourself.

[[Category:Server]]
[[Category:Web Applications]]