mirror of
https://github.com/YunoHost-Apps/lionwiki-t2t_ynh.git
synced 2024-09-03 19:36:27 +02:00
maj readme
+ fix dépendance exterieure
This commit is contained in:
farvardin
parent
be46836589
commit
7ea1e6fc3b
5 changed files with 110 additions and 91 deletions
96
README.md
96
README.md
|
|
@ -3,16 +3,6 @@
|
|||
# Lionwiki-t2t for YunoHost
|
||||
|
||||
|
||||
## Todo: to package it correctly: https://yunohost.org/#/packaging_apps_fr
|
||||
|
||||
|
||||
# Usage of this package
|
||||
|
||||
|
||||
# Example app for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)
|
||||
[](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
|
|
@ -20,68 +10,86 @@
|
|||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||
|
||||
## Overview
|
||||
Quick description of this app.
|
||||
|
||||
**Shipped version:** 1.0
|
||||
LionWiki is a minimalist Wiki engine programmed in PHP. It is extensible, templatable, file based (it doesn't need database like MySQL) and requires just one file to function (30 kb). It is suitable for small websites, personal notebooks or journals. This version is using the lightweight markup language TXT2TAGS.
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
## Screenshot
|
||||
|
||||
## Demo
|
||||
|
||||
|
||||
* [Official demo](Link to a demo site for this app)
|
||||
|
||||
## Configuration
|
||||
|
||||
How to configure this app: by an admin panel, a plain file with SSH, or any other way.
|
||||
In the root folder of this app, there are two files: config.php and config.t2t for changing password and general behavior.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: Link to the official documentation of this app
|
||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
||||
* Official documentation: https://github.com/farvardin/lionwiki-t2t
|
||||
* More about txt2tags: https://github.com/farvardin/whatistxt2tags
|
||||
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-users support
|
||||
|
||||
Are LDAP and HTTP auth supported?
|
||||
Can the app be used by multiple users?
|
||||
This is only a single password for editing the wiki (it's not multi-user), and one other password for administration. Both are set to the same one defined in the lionwiki-t2t during the installation by YunoHost.
|
||||
|
||||
You can set the wiki to private (only readable when you are connected to YunoHost SSO) or public (readable by the whole internet).
|
||||
|
||||
You can install multiple instance of this app.
|
||||
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
||||
* All. It's only using PHP.
|
||||
|
||||
|
||||
## Limitations
|
||||
|
||||
* Any known limitations.
|
||||
* No different user accounts. Configuration only by ssh.
|
||||
|
||||
|
||||
## Additional information
|
||||
|
||||
* Other information you would add about this application
|
||||
You must define a base color during the installation (in hexadecimal format). You can choose it using this online tool for example: https://www.w3schools.com/colors/colors_picker.asp
|
||||
|
||||
|
||||
It will modify the templates/minimaxing/minimaxing.less file and compile it using the lessc command (from the node-less package).
|
||||
|
||||
After the installation, you can edit the base color found in /var/www/lionwikit2t/templates/minimaxing/minimaxing.less file.
|
||||
|
||||
Search for:
|
||||
|
||||
```
|
||||
/* For YunoHost config */
|
||||
@MainColor: #D17732;
|
||||
```
|
||||
|
||||
Go inside your installation folder (adapt it to your case, if it's the second instance you've installed, it will be named /var/www/lionwikit2t__2/):
|
||||
|
||||
```
|
||||
cd /var/www/lionwikit2t
|
||||
```
|
||||
|
||||
|
||||
Then compile it with:
|
||||
|
||||
```
|
||||
lessc templates/minimaxing/minimaxing.less > templates/minimaxing/minimaxing.css
|
||||
```
|
||||
|
||||
If something goes wrong, you can go back to the original default file:
|
||||
|
||||
```
|
||||
cp templates/minimaxing/minimaxing_org.css templates/minimaxing/minimaxing.css
|
||||
```
|
||||
|
||||
|
||||
**More information on the documentation page:**
|
||||
https://yunohost.org/packaging_apps
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
|
||||
* App website: Link to the official website of this app
|
||||
* Upstream app repository: Link to the official repository of the upstream app
|
||||
* Report a bug: https://github.com/farvardin/lionwiki-t2t_ynh/issues
|
||||
* App website: https://github.com/farvardin/lionwiki-t2t
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Developers info
|
||||
----------------
|
||||
|
||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
|
||||
```
|
||||
|
|
|
|||
87
README_fr.md
87
README_fr.md
|
|
@ -1,77 +1,88 @@
|
|||
# App exemple pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)
|
||||
[](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
|
||||
|
||||
# Lionwiki-t2t pour YunoHost
|
||||
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
|
||||
> *Ce package vous permet d'installer REPLACEBYYOURAPP rapidement et simplement sur un serveur Yunohost.
|
||||
> *Ce package vous permet d'installer Lionwiki-t2t 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
|
||||
Description rapide de cette application.
|
||||
|
||||
**Version incluse:** 1.0
|
||||
Lionwiki-t2t est un système de type wiki minimaliste, programmé en PHP. Il est extensible et n'utilise que des fichiers plats pour sa base de données. Il est adapté pour la création de petits sites web, de notes personnelles ou de journaux. Cette version utilise le langage de balisage léger TXT2TAGS.
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
## Capture d'écran
|
||||
|
||||
## Démo
|
||||
|
||||
|
||||
* [Démo officielle](Lien vers un site de démonstration pour cette application)
|
||||
|
||||
## Configuration
|
||||
|
||||
Comment configurer cette application: via le panneau d'administration, un fichier brut en SSH ou tout autre moyen.
|
||||
Dans le dossier racine de l'application il y a 2 fichiers, config.php et config.t2t qui permettent de modifier le mot de passe et le comportement général.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Documentation officielle: Lien vers la documentation officielle de cette application
|
||||
* Documentation YunoHost: Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
|
||||
* Documentation officielle: https://github.com/farvardin/lionwiki-t2t
|
||||
* À propos de txt2tags: https://github.com/farvardin/whatistxt2tags
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
|
||||
#### Support multi-utilisateurs
|
||||
|
||||
L'authentification LDAP et HTTP est-elle prise en charge?
|
||||
L'application peut-elle être utilisée par plusieurs utilisateurs?
|
||||
Il y a un seul mot de passe pour éditer ce wiki (dans le fichier config.php), et un autre pour l'administration. C'est le même qui a a été créé lors de l'installation par YunoHost.
|
||||
|
||||
Vous pouvez passer le wiki en mode privé ou public, selon vos usages.
|
||||
|
||||
|
||||
#### Architectures supportées
|
||||
|
||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
||||
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/)
|
||||
* Toutes, cela utilise PHP.
|
||||
|
||||
## Limitations
|
||||
|
||||
* Limitations connues.
|
||||
* Un seul compte utilisateur. Configuration seulement par fichier éditable en ssh.
|
||||
|
||||
## Informations additionnelles
|
||||
|
||||
* Autres informations à ajouter sur cette application
|
||||
Vous devez définir une couleur de base durant l'installation, au format hexadécimal. Vous pouvez la choisir en utilisant cet outil en ligne : https://www.w3schools.com/colors/colors_picker.asp
|
||||
|
||||
La couleur choisie va modifier le fichier templates/minimaxing/minimaxing.less et le compiler en utilisant la commande lessc (du paquet node-less).
|
||||
|
||||
Après l'installation, vous pouvez éditer la couleur de base dans le fichier /var/www/lionwikit2t/templates/minimaxing/minimaxing.less
|
||||
|
||||
Recherchez pour :
|
||||
|
||||
```
|
||||
/* For YunoHost config */
|
||||
@MainColor: #D17732;
|
||||
```
|
||||
|
||||
Allez dans le dossier d'installation (à adapter à votre cas, si c'est la seconde instance installée, cela sera nommé /var/www/lionwikit2t__2/):
|
||||
|
||||
```
|
||||
cd /var/www/lionwikit2t
|
||||
```
|
||||
|
||||
Ensuite compilez le fichier avec :
|
||||
|
||||
```
|
||||
lessc templates/minimaxing/minimaxing.less > templates/minimaxing/minimaxing.css
|
||||
```
|
||||
|
||||
Si quelque chose se passe mal, vous pouvez revenir au fichier original :
|
||||
|
||||
```
|
||||
cp templates/minimaxing/minimaxing_org.css templates/minimaxing/minimaxing.css
|
||||
```
|
||||
|
||||
|
||||
**Plus d'informations sur la page de documentation:**
|
||||
https://yunohost.org/packaging_apps
|
||||
|
||||
## Liens
|
||||
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
|
||||
* Site de l'application: Lien vers le site officiel de cette application
|
||||
* Dépôt de l'application principale: Lien vers le dépôt officiel de l'application principale
|
||||
* Signaler un bug: https://github.com/farvardin/lionwiki-t2t_ynh/issues
|
||||
* Site de l'application: https://github.com/farvardin/lionwiki-t2t
|
||||
* Site web YunoHost: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Informations pour les développeurs
|
||||
----------------
|
||||
|
||||
**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.**
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
|
||||
```
|
||||
|
|
|
|||
|
|
@ -46,9 +46,9 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont
|
|||
/* if you prefer to select a fixed background color, just uncomment one color from below */
|
||||
/* @MainColor: #549136; */
|
||||
/* @MainColor: #7E2434; */
|
||||
@MainColor: #7e3821;
|
||||
/* @MainColor: #7e3821; */
|
||||
/* @MainColor: #549136; */
|
||||
/* @MainColor: #549136; */
|
||||
@MainColor: #549136;
|
||||
|
||||
/* For YunoHost config */
|
||||
@MainColor: #__YNH_COLOR__;
|
||||
|
|
|
|||
|
|
@ -38,8 +38,8 @@
|
|||
"en": "Choose a path for lionwiki-t2t",
|
||||
"fr": "Choisissez un chemin pour lionwiki-t2t"
|
||||
},
|
||||
"example": "/lionwiki-t2t",
|
||||
"default": "/lionwiki-t2t"
|
||||
"example": "/lionwiki",
|
||||
"default": "/lionwiki"
|
||||
},
|
||||
{
|
||||
"name": "admin",
|
||||
|
|
@ -106,7 +106,7 @@
|
|||
"en": "Use hexadecimal value (6 figures without #)",
|
||||
"fr": "Utilisez une valeur hexadecimale (6 chiffres sans # devant)"
|
||||
},
|
||||
"example": "D07732"
|
||||
"example": "D17732"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -113,7 +113,7 @@ ynh_app_setting_set --app=$app --key=port --value=$port
|
|||
### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
|
||||
### - And the section "UPGRADE DEPENDENCIES" in the upgrade script
|
||||
|
||||
#ynh_install_app_dependencies $pkg_dependencies
|
||||
ynh_install_app_dependencies $pkg_dependencies
|
||||
|
||||
#=================================================
|
||||
# CREATE A MYSQL DATABASE
|
||||
|
|
@ -183,7 +183,7 @@ ynh_add_fpm_config
|
|||
cp ../conf/config.php $final_path/
|
||||
|
||||
cp ../conf/minimaxing.less $final_path/templates/minimaxing/
|
||||
#cp ../conf/minimaxing.css $final_path/templates/minimaxing/
|
||||
cp ../conf/minimaxing.css $final_path/templates/minimaxing/minimaxing_org.css
|
||||
|
||||
# we already use the default html template
|
||||
#cp ../conf/minimaxing.html $final_path/templates/
|
||||
|
|
|
|||
Loading…
Reference in a new issue