mirror of https://github.com/YunoHost-Apps/ifconfig-io_ynh.git synced 2024-09-03 20:36:27 +02:00

IP API service

closember

Find a file

Félix Piédallu 47c908f8dd Do not remove logs on app removal		2024-06-21 14:27:56 +02:00
.github	Apply example_ynh	2022-01-15 20:47:26 +01:00
conf	Update systemd.service	2024-01-07 02:00:39 +01:00
doc	fix	2023-12-15 20:00:42 +01:00
scripts	Do not remove logs on app removal	2024-06-21 14:27:56 +02:00
sources	Apply example_ynh	2022-01-15 20:47:26 +01:00
.gitignore	Initial commit	2021-02-21 21:04:26 +01:00
ALL_README.md	Auto-update READMEs	2024-06-20 10:53:01 +00:00
LICENSE	Apply example_ynh	2022-01-15 20:47:26 +01:00
manifest.toml	Upgrade to v2024.04.20	2024-06-21 10:37:37 +02:00
README.md	Auto-update READMEs	2024-06-21 08:37:49 +00:00
README_es.md	Auto-update READMEs	2024-06-21 08:37:49 +00:00
README_eu.md	Auto-update READMEs	2024-06-21 08:37:49 +00:00
README_fr.md	Auto-update READMEs	2024-06-21 08:37:49 +00:00
README_gl.md	Auto-update READMEs	2024-06-21 08:37:49 +00:00
README_it.md	Auto-update README	2024-03-29 07:07:32 +01:00
README_zh_Hans.md	Auto-update READMEs	2024-06-21 08:37:49 +00:00
tests.toml	v2	2023-12-15 19:56:43 +01:00

README.md

ifconfig-io for YunoHost

Read this README in other languages.

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 to learn how to install it.

Overview

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.

Shipped version: 2024.04.20~ynh1

Demo: https://ifconfig.io

Documentation and resources

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 Store: https://apps.yunohost.org/app/ifconfig-io
Report a bug: https://github.com/YunoHost-Apps/ifconfig-io_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

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

More info regarding app packaging: https://yunohost.org/packaging_apps