mirror of
https://github.com/YunoHost-Apps/bookstack_ynh.git
synced 2024-09-03 18:16:02 +02:00
Éric Gaspar
GitHub
parent
ad39f14ce5
commit
b7abcc46a0
11 changed files with 159 additions and 111 deletions
55
.github/ISSUE_TEMPLATE.md
vendored
Normal file
55
.github/ISSUE_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently.
|
||||
|
||||
---
|
||||
|
||||
**How to post a meaningful bug report**
|
||||
1. *Read this whole template first.*
|
||||
2. *Determine if you are on the right place:*
|
||||
- *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!*
|
||||
- *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.*
|
||||
- *When in doubt, post here and we will figure it out together.*
|
||||
3. *Delete the italic comments as you write over them below, and remove this guide.*
|
||||
---
|
||||
|
||||
### Describe the bug
|
||||
|
||||
*A clear and concise description of what the bug is.*
|
||||
|
||||
### Context
|
||||
|
||||
- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...*
|
||||
- YunoHost version: x.x.x
|
||||
- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...*
|
||||
- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes*
|
||||
- If yes, please explain:
|
||||
- Using, or trying to install package version/branch:
|
||||
- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`*
|
||||
|
||||
### Steps to reproduce
|
||||
|
||||
- *If you performed a command from the CLI, the command itself is enough. For example:*
|
||||
```sh
|
||||
sudo yunohost app install the_app
|
||||
```
|
||||
- *If you used the webadmin, please perform the equivalent command from the CLI first.*
|
||||
- *If the error occurs in your browser, explain what you did:*
|
||||
1. *Go to '...'*
|
||||
2. *Click on '...'*
|
||||
3. *Scroll down to '...'*
|
||||
4. *See error*
|
||||
|
||||
### Expected behavior
|
||||
|
||||
*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.*
|
||||
|
||||
### Logs
|
||||
|
||||
*When an operation fails, YunoHost provides a simple way to share the logs.*
|
||||
- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.*
|
||||
- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.*
|
||||
|
||||
*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)*
|
||||
|
||||
*If applicable and useful, add screenshots to help explain your problem.*
|
||||
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
## Problem
|
||||
|
||||
- *Description of why you made this PR*
|
||||
|
||||
## Solution
|
||||
|
||||
- *And how do you fix that problem*
|
||||
|
||||
## PR Status
|
||||
|
||||
- [ ] Code finished and ready to be reviewed/tested
|
||||
- [ ] The fix/enhancement were manually tested (if applicable)
|
||||
|
||||
## Automatic tests
|
||||
|
||||
Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization)
|
||||
72
README.md
72
README.md
|
|
@ -1,27 +1,40 @@
|
|||
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
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)
|
||||
[](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.*
|
||||
> *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 a simple, self-hosted, easy-to-use platform for organising and storing information. It is an opinionated wiki system that provides a pleasant and simple out of the box experience.
|
||||
|
||||
BookStack is built using PHP, on top of the Laravel framework and it uses MySQL to store data.
|
||||
Platform to create documentation/wiki content
|
||||
|
||||
**Shipped version:** 21.04.6~ynh1
|
||||
|
||||
**Demo:** https://demo.bookstackapp.com
|
||||
|
||||
**Shipped version:** 21.04.4
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
## Demo
|
||||
|
||||
|
||||
* [Official demo](https://demo.bookstackapp.com/)
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
## Configuration
|
||||
|
||||
|
|
@ -29,39 +42,16 @@ For the first time Login, use the default credentials `admin@admin.com` and `pas
|
|||
|
||||
* 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: https://yunohost.org/en/app_bookstack
|
||||
|
||||
## YunoHost specific features
|
||||
## Documentation and resources
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
* Are LDAP and HTTP auth supported? **Yes**
|
||||
* Can the app be used by multiple users? **Yes**
|
||||
|
||||
#### 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: https://www.bookstackapp.com/
|
||||
* Upstream app repository: https://github.com/BookStackApp/BookStack
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
* 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
|
||||
|
||||
|
|
@ -73,3 +63,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/te
|
|||
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
|
||||
76
README_fr.md
76
README_fr.md
|
|
@ -1,73 +1,57 @@
|
|||
# BookStack pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/bookstack)  
|
||||
[](https://install-app.yunohost.org/?app=bookstack)
|
||||
[](https://dash.yunohost.org/appci/app/bookstack)  
|
||||
[](https://install-app.yunohost.org/?app=bookstack)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer BookStack rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/install) pour apprendre comment l'installer.*
|
||||
> *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 est une plate-forme simple, auto-hébergée et facile à utiliser pour organiser et stocker des informations.
|
||||
## Vue d'ensemble
|
||||
|
||||
**Version incluse :** 21.04.4
|
||||
Plateforme pour créer du contenu de documentation/wiki
|
||||
|
||||
## Screenshots
|
||||
**Version incluse:** 21.04.6~ynh1
|
||||
|
||||
|
||||
**Démo:** https://demo.bookstackapp.com
|
||||
|
||||
## Démo
|
||||
|
||||
* [Démo officielle](https://demo.bookstackapp.com/)
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
## Configuration
|
||||
|
||||
Login using the default admin details `admin@admin.com` with a password of `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
|
||||
|
||||
* Documentation officielle : https://www.bookstackapp.com/docs/
|
||||
* Documentation YunoHost : https://yunohost.org/fr/app_bookstack
|
||||
## Documentations et ressources
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
|
||||
#### Support multi-utilisateur
|
||||
|
||||
* L'authentification LDAP et HTTP est-elle prise en charge ? **Oui**
|
||||
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
|
||||
|
||||
#### Architectures supportées
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/bookstack/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/bookstack/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* Limitations connues.
|
||||
|
||||
## Informations additionnelles
|
||||
|
||||
* Autres informations que vous souhaitez ajouter sur cette application.
|
||||
|
||||
## Liens
|
||||
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/bookstack_ynh/issues
|
||||
* Site de l'application : https://www.bookstackapp.com/
|
||||
* Dépôt de l'application principale : https://github.com/BookStackApp/BookStack
|
||||
* Site web YunoHost : https://yunohost.org/
|
||||
|
||||
---
|
||||
* Site official de l'app : https://www.bookstackapp.com
|
||||
* Documentation officielle utilisateur: https://yunohost.org/en/app_bookstack
|
||||
* Documentation officielle de l'admin: https://www.bookstackapp.com/docs
|
||||
* Dépôt de code officiel de l'app: https://github.com/BookStackApp/BookStack
|
||||
* Documentation YunoHost pour cette app: https://yunohost.org/app_bookstack
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/bookstack_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing).
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps
|
||||
|
|
@ -3,10 +3,10 @@
|
|||
|
||||
;; Test complet
|
||||
; Manifest
|
||||
domain="domain.tld" (DOMAIN)
|
||||
path="/path" (PATH)
|
||||
domain="domain.tld"
|
||||
path="/path"
|
||||
language="fr"
|
||||
is_public=1 (PUBLIC|public=1|private=0)
|
||||
is_public=1
|
||||
; Checks
|
||||
pkg_linter=1
|
||||
setup_sub_dir=1
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
setup_private=1
|
||||
setup_public=1
|
||||
upgrade=1
|
||||
upgrade=1 from_commit=a1db7396ceab19640e68d6a8cc05befd1f9c07ad
|
||||
upgrade=1 from_commit=ad39f14ce54d80d30c2e847d0b47a7b5af6b6920
|
||||
backup_restore=1
|
||||
multi_instance=0
|
||||
change_url=0
|
||||
|
|
@ -23,6 +23,6 @@
|
|||
Email=
|
||||
Notification=none
|
||||
;;; Upgrade options
|
||||
; commit=a1db7396ceab19640e68d6a8cc05befd1f9c07ad
|
||||
name=Testing (#11)
|
||||
; commit=ad39f14ce54d80d30c2e847d0b47a7b5af6b6920
|
||||
name=Testing
|
||||
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666&
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
SOURCE_URL=https://github.com/BookStackApp/BookStack/archive/refs/tags/v21.04.4.tar.gz
|
||||
SOURCE_SUM=c8b4a13596f0d4c9992594b79a0bd8e911efb483ebb1eb06895d50edd40a583e
|
||||
SOURCE_URL=https://github.com/BookStackApp/BookStack/archive/refs/tags/v21.04.6.tar.gz
|
||||
SOURCE_SUM=2aa677448e5eb255e3045c1a4956873aea2216a50b4c8328ea6c107a5573486c
|
||||
SOURCE_SUM_PRG=sha256sum
|
||||
SOURCE_FORMAT=tar.gz
|
||||
SOURCE_IN_SUBDIR=true
|
||||
|
|
|
|||
5
doc/DISCLAIMER.md
Normal file
5
doc/DISCLAIMER.md
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
## 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.
|
||||
3
doc/DISCLAIMER_fr.md
Normal file
3
doc/DISCLAIMER_fr.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
## Configuration
|
||||
|
||||
Login using the default admin details `admin@admin.com` with a password of `password`. You should change these details immediately after logging in for the first time.
|
||||
BIN
doc/screenshots/bookstack-hero-screenshot.jpg
Normal file
BIN
doc/screenshots/bookstack-hero-screenshot.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 194 KiB |
|
|
@ -6,8 +6,16 @@
|
|||
"en": "Platform to create documentation/wiki content",
|
||||
"fr": "Plateforme pour créer du contenu de documentation/wiki "
|
||||
},
|
||||
"version": "21.04.4~ynh1",
|
||||
"version": "21.04.6~ynh1",
|
||||
"url": "https://www.bookstackapp.com/",
|
||||
"upstream": {
|
||||
"license": "MIT",
|
||||
"website": "https://www.bookstackapp.com",
|
||||
"demo": "https://demo.bookstackapp.com",
|
||||
"admindoc": "https://www.bookstackapp.com/docs",
|
||||
"userdoc": "https://yunohost.org/en/app_bookstack",
|
||||
"code": "https://github.com/BookStackApp/BookStack"
|
||||
},
|
||||
"license": "MIT",
|
||||
"maintainer": {
|
||||
"name": "liberodark",
|
||||
|
|
|
|||
|
|
@ -61,23 +61,8 @@ if [ "$upgrade_type" == "UPGRADE_APP" ]
|
|||
then
|
||||
ynh_script_progression --message="Upgrading source files..." --weight=1
|
||||
|
||||
# Create a temporary directory
|
||||
tmpdir="$(mktemp -d)"
|
||||
|
||||
# Backup the config file in the temp dir
|
||||
cp -a "$final_path/.env" "$tmpdir/.env"
|
||||
|
||||
# Remove the app directory securely
|
||||
ynh_secure_remove --file="$final_path"
|
||||
|
||||
# Download, check integrity, uncompress and patch the source from app.src
|
||||
ynh_setup_source --dest_dir="$final_path"
|
||||
|
||||
# Copy the admin saved settings from tmp directory to final path
|
||||
cp -a "$tmpdir/.env" "$final_path/.env"
|
||||
|
||||
# Remove the tmp directory securely
|
||||
ynh_secure_remove --file="$tmpdir"
|
||||
ynh_setup_source --dest_dir="$final_path" --keep="$final_path/.env"
|
||||
fi
|
||||
|
||||
#=================================================
|
||||
|
|
|
|||
Loading…
Reference in a new issue