YunoHost-Apps/2fauth_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/2FAuth_ynh.git synced 2024-09-03 20:36:18 +02:00
Code Issues Activity Actions

Merge branch 'testing' into pr/65

Browse source
This commit is contained in:
Éric Gaspar 2024-04-09 09:33:49 +02:00
commit 6871462ed2
6 changed files with 146 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ALL_README.md Normal file
View file

@ -0,0 +1,6 @@
# All available README files by language
- [Read the README in English](README.md)
- [Irakurri README euskaraz](README_eu.md)
- [Lire le README en français](README_fr.md)
- [Le o README en galego](README_gl.md)

15
README.md
View file

@ -1,5 +1,5 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator 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. It shall NOT be edited by hand.
--> -->
@ -9,10 +9,10 @@ It shall NOT be edited by hand.
[![Install 2FAuth with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth) [![Install 2FAuth with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth)
*[Lire ce readme en français.](./README_fr.md)* *[Read this README in other languages.](./ALL_README.md)*
> *This package allows you to install 2FAuth quickly and simply on a YunoHost server. > *This package allows you to install 2FAuth 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.* > *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview ## Overview
@ -26,7 +26,8 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
- Add custom account without QR code thanks to an advanced form - Add custom account without QR code thanks to an advanced form
- Edit accounts, even the imported ones - Edit accounts, even the imported ones
- Generate TOTP and HOTP security codes - Generate TOTP and HOTP security codes
**Shipped version:** 5.1.0~ynh1
**Shipped version:** 5.1.1~ynh1
**Demo:** <https://demo.2fauth.app/login> **Demo:** <https://demo.2fauth.app/login>
@ -43,9 +44,9 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing). Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the `testing` branch, please proceed like that:
```bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug

57
README_eu.md Normal file
View file

@ -0,0 +1,57 @@
<!--
Ohart ongi: README hau automatikoki sortu da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>ri esker
EZ editatu eskuz.
-->
# 2FAuth YunoHost-erako
[![Integrazio maila](https://dash.yunohost.org/integration/2fauth.svg)](https://dash.yunohost.org/appci/app/2fauth) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/2fauth.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/2fauth.maintain.svg)
[![Instalatu 2FAuth YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth)
*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)*
> *Pakete honek 2FAuth YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.*
> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.*
## Aurreikuspena
2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator, designed for both mobile and desktop.
2FAuth aims to ease you perform your 2FA authentication steps whatever the device you handle, with a clean and suitable interface.
### Features
- Manage your 2FA accounts and organize them using Groups
- Scan and decode any QR code to add account in no time
- Add custom account without QR code thanks to an advanced form
- Edit accounts, even the imported ones
- Generate TOTP and HOTP security codes
**Paketatutako bertsioa:** 5.1.1~ynh1
**Demoa:** <https://demo.2fauth.app/login>
## Pantaila-argazkiak
![2FAuth(r)en pantaila-argazkia](./doc/screenshots/screenshot.png)
## Dokumentazioa eta baliabideak
- Administratzaileen dokumentazio ofiziala: <https://docs.2fauth.app/>
- Jatorrizko aplikazioaren kode-gordailua: <https://github.com/Bubka/2FAuth>
- YunoHost Denda: <https://apps.yunohost.org/app/2fauth>
- Eman errore baten berri: <https://github.com/YunoHost-Apps/2fauth_ynh/issues>
## Garatzaileentzako informazioa
Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing).
`testing` abarra probatzeko, ondorengoa egin:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug
edo
sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug
```
**Informazio gehiago aplikazioaren paketatzeari buruz:** <https://yunohost.org/packaging_apps>

29
README_fr.md
View file

@ -1,6 +1,6 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand. Il NE doit PAS être modifié à la main.
--> -->
# 2FAuth pour YunoHost # 2FAuth pour YunoHost
@ -9,10 +9,10 @@ It shall NOT be edited by hand.
[![Installer 2FAuth avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth) [![Installer 2FAuth avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth)
*[Read this readme in english.](./README.md)* *[Lire le README dans d'autres langues.](./ALL_README.md)*
> *Ce package vous permet d’installer 2FAuth rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d’installer 2FAuth 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.* > *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
## Vue d’ensemble ## Vue d’ensemble
@ -26,9 +26,10 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
- Ajoutez un compte personnalisé sans QR code grâce à un formulaire avancé - Ajoutez un compte personnalisé sans QR code grâce à un formulaire avancé
- Modifier les comptes, même ceux importés - Modifier les comptes, même ceux importés
- Générer des codes de sécurité TOTP et HOTP - Générer des codes de sécurité TOTP et HOTP
**Version incluse :** 5.1.0~ynh1
**Démo :** <https://demo.2fauth.app/login> **Version incluse :** 5.1.1~ynh1
**Démo :** <https://demo.2fauth.app/login>
## Captures d’écran ## Captures d’écran
@ -36,16 +37,16 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
## Documentations et ressources ## Documentations et ressources
- Documentation officielle de l’admin : <https://docs.2fauth.app/> - Documentation officielle de l’admin : <https://docs.2fauth.app/>
- Dépôt de code officiel de l’app : <https://github.com/Bubka/2FAuth> - Dépôt de code officiel de l’app : <https://github.com/Bubka/2FAuth>
- YunoHost Store : <https://apps.yunohost.org/app/2fauth> - YunoHost Store : <https://apps.yunohost.org/app/2fauth>
- Signaler un bug : <https://github.com/YunoHost-Apps/2fauth_ynh/issues> - Signaler un bug : <https://github.com/YunoHost-Apps/2fauth_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing). Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche `testing`, procédez comme suit :
```bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug
@ -53,4 +54,4 @@ ou
sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_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>

57
README_gl.md Normal file
View file

@ -0,0 +1,57 @@
<!--
NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
NON debe editarse manualmente.
-->
# 2FAuth para YunoHost
[![Nivel de integración](https://dash.yunohost.org/integration/2fauth.svg)](https://dash.yunohost.org/appci/app/2fauth) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/2fauth.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/2fauth.maintain.svg)
[![Instalar 2FAuth con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth)
*[Le este README en outros idiomas.](./ALL_README.md)*
> *Este paquete permíteche instalar 2FAuth de xeito rápido e doado nun servidor YunoHost.*
> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.*
## Vista xeral
2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator, designed for both mobile and desktop.
2FAuth aims to ease you perform your 2FA authentication steps whatever the device you handle, with a clean and suitable interface.
### Features
- Manage your 2FA accounts and organize them using Groups
- Scan and decode any QR code to add account in no time
- Add custom account without QR code thanks to an advanced form
- Edit accounts, even the imported ones
- Generate TOTP and HOTP security codes
**Versión proporcionada:** 5.1.1~ynh1
**Demo:** <https://demo.2fauth.app/login>
## Capturas de pantalla
![Captura de pantalla de 2FAuth](./doc/screenshots/screenshot.png)
## Documentación e recursos
- Documentación oficial para admin: <https://docs.2fauth.app/>
- Repositorio de orixe do código: <https://github.com/Bubka/2FAuth>
- Tenda YunoHost: <https://apps.yunohost.org/app/2fauth>
- Informar dun problema: <https://github.com/YunoHost-Apps/2fauth_ynh/issues>
## Info de desenvolvemento
Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing).
Para probar a rama `testing`, procede deste xeito:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug
ou
sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug
```
**Máis info sobre o empaquetado da app:** <https://yunohost.org/packaging_apps>

6
manifest.toml
View file

@ -5,7 +5,7 @@ name = "2FAuth"
description.en = "self-hosted alternative to One Time Passcode" description.en = "self-hosted alternative to One Time Passcode"
description.fr = "Alternative auto-hébergée a One Time Passcode" description.fr = "Alternative auto-hébergée a One Time Passcode"
version = "5.1.0~ynh1" version = "5.1.1~ynh1"
maintainers = [] maintainers = []
@ -44,8 +44,8 @@ ram.runtime = "50M"
[resources.sources] [resources.sources]
[resources.sources.main] [resources.sources.main]
url = "https://github.com/Bubka/2FAuth/archive/refs/tags/v5.1.0.tar.gz" url = "https://github.com/Bubka/2FAuth/archive/refs/tags/v5.1.1.tar.gz"
sha256 = "fb811ab6567986c48d20358e7f24f099fa1c4cbc05982c47e40d94a3df121425" sha256 = "2e745b8770ae0bf38ae62a6d42f9f01d417cc36f03a02672b686bc7d155719e1"
autoupdate.strategy = "latest_github_tag" autoupdate.strategy = "latest_github_tag"
[resources.system_user] [resources.system_user]