2021-01-28 23:21:19 +01:00
|
|
|
# BookStack for YunoHost
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
[](https://dash.yunohost.org/appci/app/bookstack)  
|
|
|
|
|
[](https://install-app.yunohost.org/?app=bookstack)
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
> *This package allows you to install BookStack quickly and simply on a YunoHost server.
|
|
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
## Overview
|
|
|
|
|
Quick description of this app.
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
**Shipped version:** 0.31.4
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
## Screenshots
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
## Demo
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
* [Official demo](https://www.bookstackapp.com/#demo)
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
## Configuration
|
2019-07-29 19:50:23 +02:00
|
|
|
|
2021-01-28 23:21:19 +01:00
|
|
|
How to configure this app: From an admin panel, a plain file with SSH, or any other way.
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
* Official documentation: https://www.bookstackapp.com/docs/
|
|
|
|
|
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
|
|
|
|
|
|
|
|
|
## YunoHost specific features
|
|
|
|
|
|
|
|
|
|
#### Multi-user support
|
|
|
|
|
|
|
|
|
|
Are LDAP and HTTP auth supported?
|
|
|
|
|
Can the app be used by multiple users?
|
|
|
|
|
|
|
|
|
|
#### Supported architectures
|
|
|
|
|
|
|
|
|
|
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/bookstack/)
|
|
|
|
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/bookstack/)
|
|
|
|
|
|
|
|
|
|
## Limitations
|
|
|
|
|
|
|
|
|
|
* Any known limitations.
|
|
|
|
|
|
|
|
|
|
## Additional information
|
|
|
|
|
|
|
|
|
|
* Other info you would like to add about this app.
|
|
|
|
|
|
|
|
|
|
## Links
|
|
|
|
|
|
|
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/bookstack_ynh/issues
|
|
|
|
|
* App website: Link to the official website of this app.
|
|
|
|
|
* Upstream app repository: https://github.com/BookStackApp/BookStack
|
|
|
|
|
* YunoHost website: https://yunohost.org/
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
|
|
|
|
|
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing).
|
|
|
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
|
```
|
|
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
|
|
|
|
|
or
|
|
|
|
|
sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
|
|
|
|
|
```
|
