1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/pgadmin_ynh.git synced 2024-09-03 19:56:38 +02:00

Refactor README

This commit is contained in:
Josué Tille 2018-08-10 01:19:48 +02:00
parent 064ca78a60
commit b8b5c63f7f
2 changed files with 73 additions and 16 deletions

View file

@ -1,35 +1,92 @@
Pgadmin for yunohost
========================
pgAdmin for yunohost
====================
*https://www.pgadmin.org
[![Integration level](https://dash.yunohost.org/integration/pgadmin.svg)](https://ci-apps.yunohost.org/jenkins/job/pgadmin%20%28Community%29/lastBuild/consoleFull)
[![Install pgadmin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pgadmin)
[![Integration level](https://dash.yunohost.org/integration/pgadmin.svg)](https://ci-apps.yunohost.org/jenkins/job/pgadmin%20%28Community%29/lastBuild/consoleFull)
> *This package allow you to install pgadmin 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.*
[![Install PgAdmin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pgadmin)
Overview
--------
pgAdmin is a feature rich Open Source administration and development platform for PostgreSQL.
**Shipped version:** 4-3.2
Screenshots
-----------
![](https://www.pgadmin.org/static/img/screenshots/pgadmin4-welcome.png)
Documentation
-------------
* Official documentation: https://www.pgadmin.org/docs/
* YunoHost documentation: There no other documentations, feel free to contribute.
YunoHost specific features
--------------------------
### Multi-users support
This app actually don't support the SSO and don't support LDAP. After the install of the app you can create a other user. So this app is multi-users but independently of the LDAP database.
### Supported architectures
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/jenkins/job/pgadmin%20(Community)/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/pgadmin%20(Community)/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/jenkins/job/pgadmin%20(Community)%20(%7EARM%7E)/badge/icon)](https://ci-apps-arm.yunohost.org/jenkins/job/pgadmin%20(Community)%20(%7EARM%7E)/)
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/jenkins/job/pgadmin%20(Community)/badge/icon)](https://ci-stretch.nohost.me/jenkins/job/pgadmin%20(Community)/)
<!--Limitations
-----------
* Any known limitations.-->
<!--Additional informations
-----------------------
* Other informations you would add about this application-->
Links
-----
* Report a bug: https://github.com/YunoHost-Apps/pgadmin_ynh/issues
* App website: https://www.pgadmin.org/
* YunoHost website: https://yunohost.org/
---
Install
-------
From command line:
`sudo yunohost app install -l Pgadmin https://github.com/YunoHost-Apps/pgadmin_ynh`
`sudo yunohost app install -l pgAdmin https://github.com/YunoHost-Apps/pgadmin_ynh`
Upgrade
-------
From command line:
`sudo yunohost app upgrade -u pgadmin https://github.com/YunoHost-Apps/pgadmin_ynh`
`sudo yunohost app upgrade pgadmin -u https://github.com/YunoHost-Apps/pgadmin_ynh`
Issue
-----
Developers infos
----------------
Any issue is welcome here : https://github.com/YunoHost-Apps/pgadmin_ynh/issues
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/pgadmin_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/pgadmin_ynh/tree/testing --debug
or
sudo yunohost app upgrade pgadmin -u https://github.com/YunoHost-Apps/pgadmin_ynh/tree/testing --debug
```
License
-------
Pgadmin is published under the the PostgreSQL licence : https://www.pgadmin.org/licence/
pgAdmin is published under the the PostgreSQL licence : https://www.pgadmin.org/licence/
TODO
----

View file

@ -1,5 +1,5 @@
{
"name": "Pgadmin",
"name": "pgAdmin",
"id": "pgadmin",
"packaging_format": 1,
"description": {
@ -27,8 +27,8 @@
"name": "domain",
"type": "domain",
"ask": {
"en": "Choose a domain for Pgadmin",
"fr": "Choisissez un domaine pour Pgadmin"
"en": "Choose a domain for pgAdmin",
"fr": "Choisissez un domaine pour pgAdmin"
},
"example": "domain.org"
},
@ -36,8 +36,8 @@
"name": "path",
"type": "path",
"ask": {
"en": "Choose a path for Pgadmin",
"fr": "Choisissez un chemin pour Pgadmin"
"en": "Choose a path for pgAdmin",
"fr": "Choisissez un chemin pour pgAdmin"
},
"example": "/pgadmin",
"default": "/pgadmin"