mirror of
https://github.com/YunoHost-Apps/lstu_ynh.git
synced 2024-09-03 19:36:12 +02:00
Apply example_ynh on README
This commit is contained in:
parent
d9da710ff7
commit
d10fe1a04e
1 changed files with 10 additions and 12 deletions
22
README.md
22
README.md
|
@ -3,11 +3,10 @@
|
||||||
[](https://dash.yunohost.org/appci/app/lstu)  
|
[](https://dash.yunohost.org/appci/app/lstu)  
|
||||||
[](https://install-app.yunohost.org/?app=lstu)
|
[](https://install-app.yunohost.org/?app=lstu)
|
||||||
|
|
||||||
> *This package allow you to install lstu quickly and simply on a YunoHost server.
|
> *This package allows you to install lstu quickly and simply on a YunoHost server.
|
||||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Lstu means Let's Shorten That Url.
|
Lstu means Let's Shorten That Url.
|
||||||
|
|
||||||
**Shipped version:** 0.22-0
|
**Shipped version:** 0.22-0
|
||||||
|
@ -22,7 +21,7 @@ Lstu means Let's Shorten That Url.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
How to configure this app: a plain file with SSH.
|
How to configure this app: a plain file at `/var/www/lstu/lstu.conf` with SSH.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
|
@ -30,34 +29,32 @@ How to configure this app: a plain file with SSH.
|
||||||
|
|
||||||
## YunoHost specific features
|
## YunoHost specific features
|
||||||
|
|
||||||
#### Multi-users support
|
#### Multi-user support
|
||||||
|
|
||||||
Are LDAP and HTTP auth supported? **Yes**
|
Are LDAP and HTTP auth supported? **Yes**
|
||||||
Can the app be used by multiple users? **Yes**
|
Can the app be used by multiple users? **Yes**
|
||||||
|
|
||||||
#### Supported architectures
|
#### Supported architectures
|
||||||
|
|
||||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/lstu/)
|
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/lstu/)
|
||||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/lstu/)
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/lstu/)
|
||||||
|
|
||||||
|
|
||||||
|
**More info on the documentation page:**
|
||||||
**More information on the documentation page:**
|
|
||||||
https://yunohost.org/packaging_apps
|
https://yunohost.org/packaging_apps
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/lstu_ynh/issues
|
* Report a bug: https://github.com/YunoHost-Apps/lstu_ynh/issues
|
||||||
* App website: https://framagit.org/fiat-tux/hat-softwares/lstu
|
* Upstream app repository: Link to the official repository of the upstream app.
|
||||||
* YunoHost website: https://yunohost.org/
|
* YunoHost website: https://yunohost.org/
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Developers info
|
Developer info
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/lstu_ynh/tree/testing).
|
||||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/lstu_ynh/tree/testing).
|
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the testing branch, please proceed like that.
|
||||||
```
|
```
|
||||||
|
@ -65,6 +62,7 @@ sudo yunohost app install https://github.com/YunoHost-Apps/lstu_ynh/tree/testing
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade lstu -u https://github.com/YunoHost-Apps/lstu_ynh/tree/testing --debug
|
sudo yunohost app upgrade lstu -u https://github.com/YunoHost-Apps/lstu_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
## Todo
|
## Todo
|
||||||
|
|
||||||
- [ ] Allow to choose the database (sqlite or PostgreSQL)
|
- [ ] Allow to choose the database (sqlite or PostgreSQL)
|
||||||
|
|
Loading…
Add table
Reference in a new issue