mirror of
https://github.com/YunoHost-Apps/bookstack_ynh.git
synced 2024-09-03 18:16:02 +02:00
56 lines
No EOL
2.2 KiB
Markdown
56 lines
No EOL
2.2 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# BookStack for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/bookstack)  
|
|
[](https://install-app.yunohost.org/?app=bookstack)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *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.*
|
|
|
|
## Overview
|
|
|
|
Platform to create documentation/wiki content
|
|
|
|
**Shipped version:** 21.05.3~ynh1
|
|
|
|
**Demo:** https://demo.bookstackapp.com
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
## Configuration
|
|
|
|
For the first time Login, use the default credentials `admin@admin.com` and `password`. You should change these details immediately after logging in for the first time.
|
|
|
|
* How to configure this app: From an admin panel, a plain file with SSH, or any other way.
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: https://www.bookstackapp.com
|
|
* Official user documentation: https://yunohost.org/en/app_bookstack
|
|
* Official admin documentation: https://www.bookstackapp.com/docs
|
|
* Upstream app code repository: https://github.com/BookStackApp/BookStack
|
|
* YunoHost documentation for this app: https://yunohost.org/app_bookstack
|
|
* Report a bug: https://github.com/YunoHost-Apps/bookstack_ynh/issues
|
|
|
|
## Developer info
|
|
|
|
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
|
|
```
|
|
|
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps |