mirror of
https://github.com/YunoHost-Apps/bookstack_ynh.git
synced 2024-09-03 18:16:02 +02:00
Éric Gaspar
GitHub
parent
b7abcc46a0
commit
68ddf04a08
9 changed files with 58 additions and 73 deletions
23
README.md
23
README.md
|
|
@ -1,7 +1,3 @@
|
|||
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
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.
|
||||
|
|
@ -9,30 +5,25 @@ 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.
|
||||
> *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.04.6~ynh1
|
||||
**Shipped version:** 21.05.2~ynh1
|
||||
|
||||
**Demo:** https://demo.bookstackapp.com
|
||||
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
|
|
@ -42,14 +33,12 @@ 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 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
|
||||
* 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
|
||||
|
||||
|
|
|
|||
37
README_fr.md
37
README_fr.md
|
|
@ -1,30 +1,25 @@
|
|||
# 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)*
|
||||
*[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.*
|
||||
> *Ce package vous permet d'installer BookStack rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Plateforme pour créer du contenu de documentation/wiki
|
||||
|
||||
**Version incluse:** 21.04.6~ynh1
|
||||
|
||||
**Démo:** https://demo.bookstackapp.com
|
||||
**Version incluse :** 21.05.2~ynh1
|
||||
|
||||
**Démo :** https://demo.bookstackapp.com
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
|
|
@ -32,16 +27,14 @@ Plateforme pour créer du contenu de documentation/wiki
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* 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
|
||||
* Site officiel 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
|
||||
|
||||
|
|
@ -50,8 +43,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno
|
|||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
|
||||
or
|
||||
ou
|
||||
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
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
# See here for more informations
|
||||
# https://github.com/YunoHost/package_check#syntax-check_process-file
|
||||
|
||||
;; Test complet
|
||||
; Manifest
|
||||
domain="domain.tld"
|
||||
|
|
@ -15,6 +12,9 @@
|
|||
setup_private=1
|
||||
setup_public=1
|
||||
upgrade=1
|
||||
#Testing (#30)
|
||||
upgrade=1 from_commit=b7abcc46a0c3c90c9b36d4c00e40d26a1aab429b
|
||||
#Testing
|
||||
upgrade=1 from_commit=ad39f14ce54d80d30c2e847d0b47a7b5af6b6920
|
||||
backup_restore=1
|
||||
multi_instance=0
|
||||
|
|
@ -23,6 +23,8 @@
|
|||
Email=
|
||||
Notification=none
|
||||
;;; Upgrade options
|
||||
; commit=b7abcc46a0c3c90c9b36d4c00e40d26a1aab429b
|
||||
name=Testing (#30)
|
||||
; commit=ad39f14ce54d80d30c2e847d0b47a7b5af6b6920
|
||||
name=Testing
|
||||
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666&
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
SOURCE_URL=https://github.com/BookStackApp/BookStack/archive/refs/tags/v21.04.6.tar.gz
|
||||
SOURCE_SUM=2aa677448e5eb255e3045c1a4956873aea2216a50b4c8328ea6c107a5573486c
|
||||
SOURCE_URL=https://github.com/BookStackApp/BookStack/archive/refs/tags/v21.05.2.tar.gz
|
||||
SOURCE_SUM=3ed1ea74f2418eba889d3088dad08804fb37326bda69ca968ceb92bb45d11ba8
|
||||
SOURCE_SUM_PRG=sha256sum
|
||||
SOURCE_FORMAT=tar.gz
|
||||
SOURCE_IN_SUBDIR=true
|
||||
SOURCE_EXTRACT=true
|
||||
SOURCE_FILENAME=bookstack.tar.gz
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
"en": "Platform to create documentation/wiki content",
|
||||
"fr": "Plateforme pour créer du contenu de documentation/wiki "
|
||||
},
|
||||
"version": "21.04.6~ynh1",
|
||||
"version": "21.05.2~ynh1",
|
||||
"url": "https://www.bookstackapp.com/",
|
||||
"upstream": {
|
||||
"license": "MIT",
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ YNH_PHP_VERSION="7.3"
|
|||
|
||||
extra_php_dependencies="php${YNH_PHP_VERSION}-mysql php${YNH_PHP_VERSION}-ldap php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-tidy php${YNH_PHP_VERSION}-xml php${YNH_PHP_VERSION}-zip php${YNH_PHP_VERSION}-gd"
|
||||
|
||||
YNH_COMPOSER_VERSION=1.10.17
|
||||
YNH_COMPOSER_VERSION=2.1.1
|
||||
|
||||
#=================================================
|
||||
# PERSONAL HELPERS
|
||||
|
|
|
|||
|
|
@ -74,6 +74,11 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path
|
|||
# Download, check integrity, uncompress and patch the source from app.src
|
||||
ynh_setup_source --dest_dir="$final_path"
|
||||
|
||||
# Set permissions to app files
|
||||
chmod 755 $final_path
|
||||
chown -R $app:www-data $final_path
|
||||
chmod -R o-rwx $final_path
|
||||
|
||||
#=================================================
|
||||
# NGINX CONFIGURATION
|
||||
#=================================================
|
||||
|
|
@ -97,7 +102,7 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
|
|||
ynh_script_progression --message="Installing BookStack with Composer..." --weight=5
|
||||
|
||||
# Install composer
|
||||
ynh_install_composer --phpversion=$phpversion --workdir=$final_path --install_args="--prefer-source --no-dev"
|
||||
ynh_install_composer --phpversion=$phpversion --workdir=$final_path --install_args="--no-dev"
|
||||
|
||||
#=================================================
|
||||
# MODIFY A CONFIG FILE
|
||||
|
|
@ -105,6 +110,7 @@ ynh_install_composer --phpversion=$phpversion --workdir=$final_path --install_ar
|
|||
|
||||
mail_pwd=$(ynh_string_random --length=12)
|
||||
ynh_add_config --template=../conf/.env.example --destination=$final_path/.env
|
||||
chmod 600 $final_path/.env
|
||||
|
||||
#=================================================
|
||||
# FINAL BOOKSTACK INSTALL
|
||||
|
|
@ -116,18 +122,6 @@ pushd $final_path
|
|||
php$phpversion artisan migrate --no-interaction --force
|
||||
popd
|
||||
|
||||
#=================================================
|
||||
# GENERIC FINALIZATION
|
||||
#=================================================
|
||||
# SECURE FILES AND DIRECTORIES
|
||||
#=================================================
|
||||
|
||||
# Set permissions to app files
|
||||
chmod 755 $final_path
|
||||
chown -R $app:www-data $final_path
|
||||
chmod -R o-rwx $final_path
|
||||
chmod 600 $final_path/.env
|
||||
|
||||
#=================================================
|
||||
# SETUP SSOWAT
|
||||
#=================================================
|
||||
|
|
|
|||
|
|
@ -62,10 +62,6 @@ ynh_script_progression --message="Restoring the app main directory..." --weight=
|
|||
|
||||
ynh_restore_file --origin_path="$final_path"
|
||||
|
||||
#=================================================
|
||||
# RESTORE USER RIGHTS
|
||||
#=================================================
|
||||
|
||||
# Restore permissions on app files
|
||||
chmod 755 $final_path
|
||||
chown -R $app:www-data $final_path
|
||||
|
|
|
|||
|
|
@ -61,8 +61,23 @@ 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" --keep="$final_path/.env"
|
||||
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"
|
||||
fi
|
||||
|
||||
#=================================================
|
||||
|
|
@ -95,17 +110,11 @@ ynh_install_composer --phpversion=$phpversion --workdir=$final_path --install_ar
|
|||
ynh_script_progression --message="Install BookStack" --weight=5
|
||||
|
||||
pushd $final_path
|
||||
php artisan migrate --no-interaction \
|
||||
&& php artisan cache:clear --no-interaction \
|
||||
&& php artisan view:clear --no-interaction
|
||||
php$phpversion artisan migrate --no-interaction \
|
||||
&& php$phpversion artisan cache:clear --no-interaction \
|
||||
&& php$phpversion artisan view:clear --no-interaction
|
||||
popd
|
||||
|
||||
#=================================================
|
||||
# GENERIC FINALIZATION
|
||||
#=================================================
|
||||
# SECURE FILES AND DIRECTORIES
|
||||
#=================================================
|
||||
|
||||
# Set permissions on app files
|
||||
chmod 755 $final_path
|
||||
chown -R $app:www-data $final_path
|
||||
|
|
|
|||
Loading…
Reference in a new issue