YunoHost-Apps/bookstack_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/bookstack_ynh.git synced 2024-09-03 18:16:02 +02:00
Code Issues Activity Actions
bookstack_ynh/README.md
Éric Gaspar f47c560c2d
Testing (#69) 
* Fix

* Update _common.sh

* Fix

* Update install

* Fix

* fix

* Fix

* fix

* Update README.md

* Update install

* Fix

* Fix

* Fix

* Fix

* Fix

* Update nginx.conf

* Update manifest.json

* Fix

* Fix

* Update .env.example

* Update .env.example

* Fix

* Fix

* Update php-fpm.conf

* Update .env.example

* Update README.md

* Update upgrade

* Update change_url

* Fix

* Update upgrade

* Fix

* Update upgrade

* Fix

* Fix

* Update upgrade

* Update check_process

* Fix

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Fix multi install

* Update php-fpm.conf

* Fix maintenance mail

* Update manifest.json

* upgrade to 0.31.5 (#10)

* 0.31.6 (#13)

* Upgrade to version 0.31.6

* Upgrade to version 0.31.7 (#15)

* Upgrade to 21.04 (#18)

* Upgrade to version 21.02

* Remove multi instance

* Update check_process

* 21.04.1 (#21)

* 21.04.2

* Upgrade to upstream (#24)

* Fix link

* upgrade to version 21.04.4 (#26)

* upgrade to version 21.04.4

* Upgrade requirements

* [autopatch] Update issue and PR templates (#28)

* Testing

* upgrade to version 21.04.4

* [autopatch] Update issue and PR templates

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>
Co-authored-by: Yunohost-Bot <>

* 21.04.5 (#29)

* Upgrade to version 21.4.6

* Add templates

* Auto-update README

* Update check_process

* Auto-update README

* 21.05 (#31)

* 21.05

* upgrade

* Auto-update README

* bump

* Auto-update README

* fix

* Update _common.sh

* Update install

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update check_process

* Update upgrade (#33)

* 21.05.3 (#34)

* 21.05.3

* Patch (#37)

* PHP8

* 21.05.4

* Auto-update README

* Update restore

* 21.08 (#39)

* 21.08

* Fix

* Auto-update README

* 21.08.2

* Auto-update README

* Update manifest.json

* Update upgrade

* 21.11 (#41)

* 21.11.2

* Update _common.sh

* Update manifest.json

* Fix

* Fix

* Update _common.sh

* Update upgrade

* Update upgrade

* 21.11.2

* Auto-update README

* Update upgrade

* Update upgrade

* Fix

* Update _common.sh

* Update manifest.json

* Auto-update README

* Update app.src

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update upgrade

* Update .env.example

* Update upgrade

* Update change_url

* Fix

* Update check_process

* Update check_process

* Update change_url

* Update change_url

* Update change_url

* Update change_url

* Update change_url

* Update _common.sh

* Update change_url

* Update change_url

* Update install

* Update install

* Update change_url

* Update change_url

* Update change_url

* Update change_url

* Update change_url

* Update change_url

* Update change_url

* Update change_url

* Update change_url

* Revert "Update change_url"

This reverts commit faec2bb235.

* Update change_url

* Update change_url

* Update change_url

* Update change_url

* Fix url (#45)

* Update change_url

* Update upgrade

* Fix url 2 (#46)

* fix

* Update change_url

* Update upgrade

* Update change_url

* Add timezone

* Fix url 2 (#47)

* Update change_url

* Update install

* Update change_url

* Admin ldap (#51)


    Define admin during install
    Add LDAP
    Add config panel

* Update check_process

* Update config_panel.toml

* Create updater.sh

* Remove password

* Auto-update README

* Fix

* Auto-update README

* Update manifest.json

* Auto-update README

* 21.12.5

* Auto-update README

* 22.02 (#55)

* 22.02

* Auto-update README

* Auto-update README

Co-authored-by: Yunohost-Bot <>

* 22.02.1

* Auto-update README

* Fix url (#48)

* Update change_url

* Add fr

* Auto-update README

* Update .env.example

* Upgrade composer

* Update upgrade

* Update upgrade

* Fix

* Update install

* 22.02.2

* Auto-update README

* Fix file size upload

* 22.02.3

* Auto-update README

* Auto-update README

* Update .env.example.complete

* Update .env.example

* Fix

* Auto-update README

* Multi instance (#61)

* multi_instance: true

* test multi_instance

* fix a typo? (weight)

* Update install

* Update upgrade

* Update manifest.json

* Auto-update README

* Update restore

* Update check_process

* 22.03

* Auto-update README

* Fix

* Auto-update README

* v22.04.1

* Auto-update README

* v22.04.2

* Auto-update README

* keep config

* Update _common.sh

* Update updater.sh

* Create updater.yml (#68)

* Update updater.sh

* Update manifest.json

* Auto-update README

* Update .env.example

* Auto-update README

* Queue worker process (#70)

* Add worker

* regenerate config file

* Set log_path to systemd

* Update change_url

Co-authored-by: tituspijean <tituspijean@outlook.com>
Co-authored-by: YunoHost Bot <yunohost-bot@users.noreply.github.com>
Co-authored-by: Yunohost-Bot <>
Co-authored-by: OniriCorpe <oniricorpe@disroot.org>
Co-authored-by: yunohost-bot <yunohost@yunohost.org>
2022-05-25 18:35:13 +02:00

68 lines
2.9 KiB
Markdown
Raw Blame History

<!--
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
[![Integration level](https://dash.yunohost.org/integration/bookstack.svg)](https://dash.yunohost.org/appci/app/bookstack) ![Working status](https://ci-apps.yunohost.org/ci/badges/bookstack.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/bookstack.maintain.svg)
[![Install BookStack with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](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
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.
### Features
- Multi-Factor Authentication
- Dark & Light Modes
- LDAP Authentication
- Optional Markdown Editor
- Multi-Lingual
**Shipped version:** 22.04.2~ynh2
**Demo:** https://demo.bookstackapp.com
## Screenshots
![Screenshot of BookStack](./doc/screenshots/bookstack-hero-screenshot.jpg)
## Disclaimers / important information
## Configuration
BookStack uses LDAP authentication by default.
You can switch to standard authentication in the webadmin -> bookstack -> config panel setting.
For the first time Login with standard authentication, use the default credentials `admin@admin.com` and `password`. You should change these details immediately after logging in for the first time.
## Documentation and resources
* Official app website: <https://www.bookstackapp.com>
* Official user documentation: <https://www.bookstackapp.com/docs/user/>
* Official admin documentation: <https://www.bookstackapp.com/docs/admin/>
* 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.
``` bash
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>
Reference in a new issue View git blame Copy permalink