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

Update: README

Browse source
This commit is contained in:
Fabian Wilkens 2022-01-15 21:13:11 +01:00
parent 948704668a
commit 72a3cc1ce3
No known key found for this signature in database
GPG key ID: 23DFA025BB4E9FAB
2 changed files with 73 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

78
README.md
View file

@ -1,73 +1,49 @@
# ifconfig.io app for YunoHost
<!--
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.
-->
[![Integration level](https://dash.yunohost.org/integration/ifconfig.io.svg)](https://dash.yunohost.org/appci/app/ifconfig.io) ![](https://ci-apps.yunohost.org/ci/badges/ifconfig.io.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ifconfig.io.maintain.svg)
[![Install ifconfig.io with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ifconfig.io)
# ifconfig.io for YunoHost
[![Integration level](https://dash.yunohost.org/integration/ifconfig-io.svg)](https://dash.yunohost.org/appci/app/ifconfig-io) ![](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.maintain.svg)
[![Install ifconfig.io with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ifconfig-io)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install ifconfig.io 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
Quick description of this app.
**Shipped version:** 2021.02.16
Inspired by ifconfig.me, but designed for pure speed. A single server can do 18,000 requests per seconds while only consuming 50megs of ram.
## Screenshots
I used the gin framework as it does several things to ensure that there are no memory allocations on each request, keeping the GC happy and preventing unnessary allocations.
![](Link to a screenshot of this app.)
Tested to handle 15,000 requests persecond on modest hardware with an average response time of 130ms.
## Demo
* [Official demo](https://ifconfig.io/)
**Shipped version:** 2021.02.16~ynh2
## Configuration
**Demo:** https://ifconfig.io
How to configure this app: From an admin panel, a plain file with SSH, or any other way.
## Documentation and resources
## Documentation
* Official documentation: Link to the official documentation of this app
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features
#### Multi-user support
Are LDAP and HTTP auth supported?
Can the app be used by multiple users?
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ifconfig.io%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/ifconfig.io/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ifconfig.io%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ifconfig.io/)
## Limitations
* Any known limitations.
## Additional information
* Other info you would like to add about this app.
**More info on the documentation page:**
https://yunohost.org/packaging_apps
## Links
* Report a bug: https://github.com/YunoHost-Apps/ifconfig.io_ynh/issues
* App website: https://ifconfig.io/
* Upstream app repository: https://github.com/georgyo/ifconfig.io
* YunoHost website: https://yunohost.org/
---
* Official app website: https://ifconfig.io/
* Official user documentation: https://github.com/georgyo/ifconfig.io/
* Official admin documentation: https://github.com/georgyo/ifconfig.io/
* Upstream app code repository: https://github.com/georgyo/ifconfig.io/
* YunoHost documentation for this app: https://yunohost.org/app_ifconfig-io
* Report a bug: https://github.com/YunoHost-Apps/ifconfig-io_ynh/issues
## 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/ifconfig.io_ynh/tree/testing).
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/ifconfig.io_ynh/tree/testing --debug
sudo yunohost app install https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
or
sudo yunohost app upgrade ifconfig.io -u https://github.com/YunoHost-Apps/ifconfig.io_ynh/tree/testing --debug
sudo yunohost app upgrade ifconfig-io -u https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
```
**More info regarding app packaging:** https://yunohost.org/packaging_apps

45
README_fr.md Normal file
View file

@ -0,0 +1,45 @@
# ifconfig.io pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/ifconfig-io.svg)](https://dash.yunohost.org/appci/app/ifconfig-io) ![](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.maintain.svg)
[![Installer ifconfig.io avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ifconfig-io)
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer ifconfig.io 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
Inspired by ifconfig.me, but designed for pure speed. A single server can do 18,000 requests per seconds while only consuming 50megs of ram.
I used the gin framework as it does several things to ensure that there are no memory allocations on each request, keeping the GC happy and preventing unnessary allocations.
Tested to handle 15,000 requests persecond on modest hardware with an average response time of 130ms.
**Version incluse :** 2021.02.16~ynh2
**Démo :** https://ifconfig.io
## Documentations et ressources
* Site officiel de l'app : https://ifconfig.io/
* Documentation officielle utilisateur : https://github.com/georgyo/ifconfig.io/
* Documentation officielle de l'admin : https://github.com/georgyo/ifconfig.io/
* Dépôt de code officiel de l'app : https://github.com/georgyo/ifconfig.io/
* Documentation YunoHost pour cette app : https://yunohost.org/app_ifconfig-io
* Signaler un bug : https://github.com/YunoHost-Apps/ifconfig-io_ynh/issues
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
```
sudo yunohost app install https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
ou
sudo yunohost app upgrade ifconfig-io -u https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps