BookStack Code Mirror - bookstack/blobdiff

# BookStack

[![GitHub release](https://img.shields.io/github/release/BookStackApp/BookStack.svg)](https://github.com/BookStackApp/BookStack/releases/latest)

# BookStack

[![GitHub release](https://img.shields.io/github/release/BookStackApp/BookStack.svg)](https://github.com/BookStackApp/BookStack/releases/latest)

-[![license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/BookStackApp/BookStack/blob/master/LICENSE)

+[![license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/BookStackApp/BookStack/blob/development/LICENSE)

[![Crowdin](https://badges.crowdin.net/bookstack/localized.svg)](https://crowdin.com/project/bookstack)

+[![Discord](https://img.shields.io/static/v1?label=chat&message=discord&color=738adb&logo=discord)](https://discord.gg/ztkBqR2)

+[![Repo Stats](https://img.shields.io/static/v1?label=GitHub+project&message=stats&color=f27e3f)](https://gh-stats.bookstackapp.com/)

[![Build Status](https://github.com/BookStackApp/BookStack/workflows/phpunit/badge.svg)](https://github.com/BookStackApp/BookStack/actions)

-[![Discord](https://img.shields.io/static/v1?label=Chat&message=Discord&color=738adb&logo=discord)](https://discord.gg/ztkBqR2)

+[![StyleCI](https://github.styleci.io/repos/41589337/shield?style=flat)](https://github.styleci.io/repos/41589337)

A platform for storing and organising information and documentation. Details for BookStack can be found on the official website at https://www.bookstackapp.com/.

* [Documentation](https://www.bookstackapp.com/docs)

* [Demo Instance](https://demo.bookstackapp.com)

* [Admin Login](https://demo.bookstackapp.com/[email protected]&password=password)

* [Documentation](https://www.bookstackapp.com/docs)

* [Demo Instance](https://demo.bookstackapp.com)

* [Admin Login](https://demo.bookstackapp.com/[email protected]&password=password)

+* [Screenshots](https://www.bookstackapp.com/#screenshots)

* [BookStack Blog](https://www.bookstackapp.com/blog)

* [Issue List](https://github.com/BookStackApp/BookStack/issues)

* [Discord Chat](https://discord.gg/ztkBqR2)

## 📚 Project Definition

* [BookStack Blog](https://www.bookstackapp.com/blog)

* [Issue List](https://github.com/BookStackApp/BookStack/issues)

* [Discord Chat](https://discord.gg/ztkBqR2)

## 📚 Project Definition

-BookStack is an opinionated wiki system that provides a pleasant and simple out of the box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it but they should not interfere with the core simple user experience.

+BookStack is an opinionated wiki system that provides a pleasant and simple out-of-the-box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it but they should not interfere with the core simple user experience.

BookStack is not designed as an extensible platform to be used for purposes that differ to the statement above.

-In regards to development philosophy, BookStack has a relaxed, open & positive approach. At the end of the day this is free software developed and maintained by people donating their own free time.

+In regard to development philosophy, BookStack has a relaxed, open & positive approach. At the end of the day this is free software developed and maintained by people donating their own free time.

+

+## 🌟 Project Sponsors

+

+Shown below are our bronze, silver and gold project sponsors.

+Big thanks to these companies for supporting the project.

+Note: Listed services are not tested, vetted nor supported by the official BookStack project in any manner.

+[View all sponsors](https://github.com/sponsors/ssddanbrown).

+

+#### Silver Sponsors

+

+<table><tbody><tr>

+<td><a href="https://www.diagrams.net/" target="_blank">

+ <img width="400" src="https://media.githubusercontent.com/media/BookStackApp/website/main/static/images/sponsors/diagramsnet.png" alt="Diagrams.net">

+</a></td>

+<td><a href="https://cloudabove.com/hosting" target="_blank">

+ <img height="100" src="https://raw.githubusercontent.com/BookStackApp/website/main/static/images/sponsors/cloudabove.svg" alt="Cloudabove">

+</a></td>

+</tr></tbody></table>

+

+#### Bronze Sponsor

+

+<table><tbody><tr>

+<td><a href="https://www.stellarhosted.com/bookstack/" target="_blank">

+ <img width="280" src="https://media.githubusercontent.com/media/BookStackApp/website/main/static/images/sponsors/stellarhosted.png" alt="Stellar Hosted">

+</a></td>

+</tr></tbody></table>

## 🛣️ Road Map

## 🚀 Release Versioning & Process

-BookStack releases are each assigned a version number, such as "v0.25.2", in the format `v<phase>.<feature>.<patch>`. A change only in the `patch` number indicates a fairly minor release that mainly contains fixes and therefore is very unlikely to cause breakages upon update. A change in the `feature` number indicates a release which will generally bring new features in addition to fixes and enhancements. These releases have a small chance of introducing breaking changes upon update so it's worth checking for any notes in the [update guide](https://www.bookstackapp.com/docs/admin/updates/). A change in the `phase` indicates a much large change in BookStack that will likely incur breakages requiring manual intervention.

+BookStack releases are each assigned a date-based version number in the format `v<year>.<month>[.<optional_patch_number>]`. For example:

+

+- `v20.12` - New feature released launched during December 2020.

+- `v21.06.2` - Second patch release upon the June 2021 feature release.

-Each BookStack release will have a [milestone](https://github.com/BookStackApp/BookStack/milestones) created with issues & pull requests assigned to it to define what will be in that release. Milestones are built up then worked through until complete at which point, after some testing and documentation updates, the release will be deployed.

+Patch releases are generally fairly minor, primarily intended for fixes and therefore is fairly unlikely to cause breakages upon update.

+Feature releases are generally larger, bringing new features in addition to fixes and enhancements. These releases have a greater chance of introducing breaking changes upon update, so it's worth checking for any notes in the [update guide](https://www.bookstackapp.com/docs/admin/updates/).

-For feature releases, and some patch releases, the release will be accompanied by a post on the [BookStack blog](https://www.bookstackapp.com/blog/) which will provide additional detail on features, changes & updates otherwise the [GitHub release page](https://github.com/BookStackApp/BookStack/releases) will show a list of changes. You can sign up to be alerted to new BookStack blogs posts (once per week maximum) [at this link](http://eepurl.com/cmmq5j).

+Each BookStack release will have a [milestone](https://github.com/BookStackApp/BookStack/milestones) created with issues & pull requests assigned to it to define what will be in that release. Milestones are built up then worked through until complete at which point, after some testing and documentation updates, the release will be deployed.

+

+Feature releases, and some patch releases, will be accompanied by a post on the [BookStack blog](https://www.bookstackapp.com/blog/) which will provide additional detail on features, changes & updates otherwise the [GitHub release page](https://github.com/BookStackApp/BookStack/releases) will show a list of changes. You can sign up to be alerted to new BookStack blogs posts (once per week maximum) [at this link](https://updates.bookstackapp.com/signup/bookstack-news-and-updates).

## 🛠️ Development & Testing

-All development on BookStack is currently done on the master branch. When it's time for a release the master branch is merged into release with built & minified CSS & JS then tagged at its version. Here are the current development requirements:

+All development on BookStack is currently done on the `development` branch. When it's time for a release the `development` branch is merged into release with built & minified CSS & JS then tagged at its version. Here are the current development requirements:

-* [Node.js](https://nodejs.org/en/) v10.0+

+* [Node.js](https://nodejs.org/en/) v14.0+

-This project uses SASS for CSS development and this is built, along with the JavaScript, using webpack. The below npm commands can be used to install the dependencies & run the build tasks:

+This project uses SASS for CSS development and this is built, along with the JavaScript, using a range of npm scripts. The below npm commands can be used to install the dependencies & run the build tasks:

``` bash

# Install NPM Dependencies

``` bash

# Install NPM Dependencies

### 📜 Code Standards

-PHP code within BookStack is generally to [PSR-2](http://www.php-fig.org/psr/psr-2/) standards. From the BookStack root folder you can run `./vendor/bin/phpcs` to check code is formatted correctly and `./vendor/bin/phpcbf` to auto-fix non-PSR-2 code. Please don't auto-fix code unless it's related to changes you've made otherwise you'll likely cause git conflicts.

+PHP code style is enforced automatically [using StyleCI](https://github.styleci.io/repos/41589337).

+If submitting a PR, any formatting changes to be made will be automatically fixed after merging.

### 🐋 Development using Docker

If all the conditions are met, you can proceed with the following steps:

-1. Install PHP/Composer dependencies with **`docker-compose run app composer install`** (first time can take a while because the image has to be built).

-2. **Copy `.env.example` to `.env`** and change `APP_KEY` to a random 32 char string.

-3. Make sure **port 8080 is unused** *or else* change `DEV_PORT` to a free port on your host.

-4. **Run `chgrp -R docker storage`**. The development container will chown the `storage` directory to the `www-data` user inside the container so BookStack can write to it. You need to change the group to your host's `docker` group here to not lose access to the `storage` directory.

-5. **Run `docker-compose up`** and wait until all database migrations have been done.

-6. You can now login with `[email protected]` and `password` as password on `localhost:8080` (or another port if specified).

+1. **Copy `.env.example` to `.env`**, change `APP_KEY` to a random 32 char string and set `APP_ENV` to `local`.

+2. Make sure **port 8080 is unused** *or else* change `DEV_PORT` to a free port on your host.

+3. **Run `chgrp -R docker storage`**. The development container will chown the `storage` directory to the `www-data` user inside the container so BookStack can write to it. You need to change the group to your host's `docker` group here to not lose access to the `storage` directory.

+4. **Run `docker-compose up`** and wait until the image is built and all database migrations have been done.

+5. You can now login with `[email protected]` and `password` as password on `localhost:8080` (or another port if specified).

If needed, You'll be able to run any artisan commands via docker-compose like so:

- ```shell script

-docker-compose run app php artisan list

+```bash

+docker-compose run app php artisan list

```

The docker-compose setup runs an instance of [MailHog](https://github.com/mailhog/MailHog) and sets environment variables to redirect any BookStack-sent emails to MailHog. You can view this mail via the MailHog web interface on `localhost:8025`. You can change the port MailHog is accessible on by setting a `DEV_MAIL_PORT` environment variable.

```

The docker-compose setup runs an instance of [MailHog](https://github.com/mailhog/MailHog) and sets environment variables to redirect any BookStack-sent emails to MailHog. You can view this mail via the MailHog web interface on `localhost:8025`. You can change the port MailHog is accessible on by setting a `DEV_MAIL_PORT` environment variable.

+#### Running tests

+

+After starting the general development Docker, migrate & seed the testing database:

+

+ ```bash

+# This only needs to be done once

+docker-compose run app php artisan migrate --database=mysql_testing

+docker-compose run app php artisan db:seed --class=DummyContentSeeder --database=mysql_testing

+```

+

+Once the database has been migrated & seeded, you can run the tests like so:

+

+ ```bash

+docker-compose run app php vendor/bin/phpunit

+```

+

+#### Debugging

+

+The docker-compose setup ships with Xdebug, which you can listen to on port 9090.

+NB : For some editors like Visual Studio Code, you might need to map your workspace folder to the /app folder within the docker container for this to work.

+

## 🌎 Translations

Translations for text within BookStack is managed through the [BookStack project on Crowdin](https://crowdin.com/project/bookstack). Some strings have colon-prefixed variables in such as `:userName`. Leave these values as they are as they will be replaced at run-time. Crowdin is the preferred way to provide translations, otherwise the raw translations files can be found within the `resources/lang` path.

## 🌎 Translations

Translations for text within BookStack is managed through the [BookStack project on Crowdin](https://crowdin.com/project/bookstack). Some strings have colon-prefixed variables in such as `:userName`. Leave these values as they are as they will be replaced at run-time. Crowdin is the preferred way to provide translations, otherwise the raw translations files can be found within the `resources/lang` path.

Pull requests are welcome. Unless a small tweak or language update, It may be best to open the pull request early or create an issue for your intended change to discuss how it will fit in to the project and plan out the merge. Just because a feature request exists, or is tagged, does not mean that feature would be accepted into the core project.

-Pull requests should be created from the `master` branch since they will be merged back into `master` once done. Please do not build from or request a merge into the `release` branch as this is only for publishing releases. If you are looking to alter CSS or JavaScript content please edit the source files found in `resources/assets`. Any CSS or JS files within `public` are built from these source files and therefore should not be edited directly.

+Pull requests should be created from the `development` branch since they will be merged back into `development` once done. Please do not build from or request a merge into the `release` branch as this is only for publishing releases. If you are looking to alter CSS or JavaScript content please edit the source files found in `resources/`. Any CSS or JS files within `public` are built from these source files and therefore should not be edited directly.

-The project's code of conduct [can be found here](https://github.com/BookStackApp/BookStack/blob/master/.github/CODE_OF_CONDUCT.md).

+The project's code of conduct [can be found here](https://github.com/BookStackApp/BookStack/blob/development/.github/CODE_OF_CONDUCT.md).

## 🔒 Security

Security information for administering a BookStack instance can be found on the [documentation site here](https://www.bookstackapp.com/docs/admin/security/).

## 🔒 Security

Security information for administering a BookStack instance can be found on the [documentation site here](https://www.bookstackapp.com/docs/admin/security/).

-If you'd like to be notified of new potential security concerns you can [sign-up to the BookStack security mailing list](http://eepurl.com/glIh8z).

+If you'd like to be notified of new potential security concerns you can [sign-up to the BookStack security mailing list](https://updates.bookstackapp.com/signup/bookstack-security-updates).

-If you would like to report a security concern in a more confidential manner than via a GitHub issue, You can directly email the lead maintainer [ssddanbrown](https://github.com/ssddanbrown). You will need to login to be able to see the email address on the [GitHub profile page](https://github.com/ssddanbrown). Alternatively you can send a DM via twitter to [@ssddanbrown](https://twitter.com/ssddanbrown).

+If you would like to report a security concern, details of doing so can [can be found here](https://github.com/BookStackApp/BookStack/blob/development/.github/SECURITY.md).

## ♿ Accessibility

The great people that have worked to build and improve BookStack can [be seen here](https://github.com/BookStackApp/BookStack/graphs/contributors).

-The wonderful people that have provided translations, either through GitHub or via Crowdin [can be seen here](https://github.com/BookStackApp/BookStack/blob/master/.github/translators.txt).

+The wonderful people that have provided translations, either through GitHub or via Crowdin [can be seen here](https://github.com/BookStackApp/BookStack/blob/development/.github/translators.txt).

These are the great open-source projects used to help build BookStack:

* [Laravel](http://laravel.com/)

* [TinyMCE](https://www.tinymce.com/)

* [CodeMirror](https://codemirror.net)

These are the great open-source projects used to help build BookStack:

* [Laravel](http://laravel.com/)

* [TinyMCE](https://www.tinymce.com/)

* [CodeMirror](https://codemirror.net)

-* [Vue.js](http://vuejs.org/)

-* [Sortable](https://github.com/SortableJS/Sortable) & [Vue.Draggable](https://github.com/SortableJS/Vue.Draggable)

+* [Sortable](https://github.com/SortableJS/Sortable)

* [Google Material Icons](https://material.io/icons/)

* [Dropzone.js](http://www.dropzonejs.com/)

* [clipboard.js](https://clipboardjs.com/)

* [markdown-it](https://github.com/markdown-it/markdown-it) and [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists)

* [Google Material Icons](https://material.io/icons/)

* [Dropzone.js](http://www.dropzonejs.com/)

* [clipboard.js](https://clipboardjs.com/)

* [markdown-it](https://github.com/markdown-it/markdown-it) and [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists)

-* [BarryVD](https://github.com/barryvdh)

- * [Debugbar](https://github.com/barryvdh/laravel-debugbar)

- * [Dompdf](https://github.com/barryvdh/laravel-dompdf)

- * [Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy)

- * [Laravel IDE helper](https://github.com/barryvdh/laravel-ide-helper)

+* [BarryVD/Dompdf](https://github.com/barryvdh/laravel-dompdf)

+* [BarryVD/Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy)

* [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html)

-* [Draw.io](https://github.com/jgraph/drawio)

-* [Laravel Stats](https://github.com/stefanzweifel/laravel-stats)

-* [OneLogin's SAML PHP Toolkit](https://github.com/onelogin/php-saml)

\ No newline at end of file

+* [diagrams.net](https://github.com/jgraph/drawio)

+* [OneLogin's SAML PHP Toolkit](https://github.com/onelogin/php-saml)

+* [League/CommonMark](https://commonmark.thephpleague.com/)

+* [League/Flysystem](https://flysystem.thephpleague.com)

+* [StyleCI](https://styleci.io/)

+* [pragmarx/google2fa](https://github.com/antonioribeiro/google2fa)

+* [Bacon/BaconQrCode](https://github.com/Bacon/BaconQrCode)

+* [phpseclib](https://github.com/phpseclib/phpseclib)

+* [Clockwork](https://github.com/itsgoingd/clockwork)

+* [PHPStan](https://phpstan.org/) & [Larastan](https://github.com/nunomaduro/larastan)

\ No newline at end of file