73 lines
2.8 KiB
Markdown
73 lines
2.8 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# My Idlers for YunoHost
|
|
|
|
[](https://ci-apps.yunohost.org/ci/apps/my_idlers/)
|
|
|
|
|
|
|
|
[](https://install-app.yunohost.org/?app=my_idlers)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install My Idlers 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
|
|
|
|
If you are the person in your family, group of friends or colleauges that manages the servers, domain names, online accounts and other hosted services, than this app is for you.
|
|
|
|
My Idlers is a useful register for keeping track of your servers and online hosting accounts.
|
|
|
|
It is a single-user app; if more than one person wants to use this functionality, it needs to be installed multiple times.
|
|
Besides that, for now, it needs a (sub)domain for itself.
|
|
|
|
This is my first app packaging attempt; there may be some rough edges.
|
|
|
|
What works:
|
|
* installing the app and using its features
|
|
* uninstalling
|
|
* backup
|
|
* moving the app to another domain
|
|
|
|
What does not (yet?) work or is untested:
|
|
* installing the app in subfolder
|
|
* LDAP integration
|
|
* restore from backup
|
|
* API access
|
|
|
|
|
|
|
|
|
|
**Shipped version:** 3.0~ynh1
|
|
|
|
**Demo:** <https://demo.myidlers.com/login>
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
- Official user documentation: <https://lowendspirit.com/discussion/2449/my-idlers-self-hosted-web-app-for-your-servers-shared-hosting-and-domains-information/>
|
|
- Upstream app code repository: <https://github.com/cp6/my-idlers#install>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/my_idlers>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/my_idlers_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/my_idlers_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/my_idlers_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade my_idlers -u https://github.com/YunoHost-Apps/my_idlers_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|