mirror of https://github.com/BookStackApp/BookStack.git synced 2024-11-22 12:55:14 +08:00

A platform to create documentation/wiki content built with PHP & Laravel

bookstack documentation laravel php selfhosted wiki

Go to file

Dan Brown 8f7c642f32 Added custom user avatars		2015-12-09 22:30:55 +00:00
app	Added custom user avatars	2015-12-09 22:30:55 +00:00
bootstrap	Change application namespace to BookStack	2015-09-10 19:31:09 +01:00
config	Added an image service and facade, Cleaned Image Model	2015-12-09 19:50:17 +00:00
database	Added custom user avatars	2015-12-09 22:30:55 +00:00
public	Added custom user avatars	2015-12-09 22:30:55 +00:00
resources	Added custom user avatars	2015-12-09 22:30:55 +00:00
storage	Initial commit	2015-07-12 20:01:42 +01:00
tests	Added Popular books list with relevant tests	2015-12-02 20:22:41 +00:00
.env.example	Added custom user avatars	2015-12-09 22:30:55 +00:00
.gitattributes	Initial commit	2015-07-12 20:01:42 +01:00
.gitignore	Added indexes, Reduced queries on pages	2015-11-26 23:45:04 +00:00
artisan	Initial commit	2015-07-12 20:01:42 +01:00
composer.json	Revamped image system to use driver-agnotstic storage and be more efficent	2015-12-07 23:00:34 +00:00
composer.lock	Revamped image system to use driver-agnotstic storage and be more efficent	2015-12-07 23:00:34 +00:00
gulpfile.js	Updated vuejs and got it working with current components	2015-11-01 20:00:57 +00:00
package.json	Updated vuejs and got it working with current components	2015-11-01 20:00:57 +00:00
phpspec.yml	Change application namespace to BookStack	2015-09-10 19:31:09 +01:00
phpunit.xml	Added tests for confirmed registration	2015-09-21 20:54:11 +01:00
readme.md	Updated readme with simpler instructions	2015-12-01 19:53:43 +00:00
server.php	Initial commit	2015-07-12 20:01:42 +01:00

readme.md

BookStack

A platform to create documentation/wiki content. General information about BookStack can be found at https://www.bookstackapp.com/

Requirements

BookStack has the similar requirements to Laravel. On top of those are some front-end build tools which are only required when developing.

PHP >= 5.5.9
OpenSSL PHP Extension
PDO PHP Extension
MBstring PHP Extension
Tokenizer PHP Extension
MySQL >= 5.6
Git (Not strictly required but helps manage updates)
Composer
Node.js Development Only
Gulp Development Only

Installation

Ensure the requirements are met before installing.

This project currently uses the release branch of this repository as a stable channel for providing updates.

The installation is currently somewhat complicated. Some PHP/Laravel experience will benefit.

Clone the release branch of this repository into a folder.

git clone https://github.com/ssddanbrown/BookStack.git --branch release --single-branch

cd into the application folder and run composer install.
Copy the .env.example file to .env and fill with your own database and mail details.
Ensure the storage & bootstrap/cache folders are writable by the web server.
In the application root, Run php artisan key:generate to generate a unique application key.
If not using apache or .htaccess files are disable you will have to create some URL rewrite rules as shown below.
Run php migrate to update the database.
Done! You can now login using the default admin details admin@admin.com with a password of password. It is recommended to change these details directly after first logging in.

URL Rewrite rules

Apache

Options +FollowSymLinks
RewriteEngine On

RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [L]

Nginx

location / {
    try_files $uri $uri/ /index.php?$query_string;
}

Testing

BookStack has many integration tests that use Laravel's built-in testing capabilities which makes use of PHPUnit. To use you will need PHPUnit installed and accessible via command line. There is a mysql_testing database defined within the app config which is what is used by PHPUnit. This database is set with the following database name, user name and password defined as bookstack-test. You will have to create that database and credentials before testing.

The testing database will also need migrating and seeding beforehand. This can be done with the following commands:

php artisan migrate --database=mysql_testing
php artisan db:seed --class=DummyContentSeeder --database=mysql_testing

Once done you can run phpunit in the application root directory to run all tests.

License

BookStack is provided under the MIT License.