doc/pages/01.administrate/06.admin_overview/07.apps/apps_overview.md

77 lines
4.9 KiB
Markdown
Raw Normal View History

2020-11-11 11:47:10 +01:00
---
title: Applications
template: docs
taxonomy:
category: docs
routes:
default: '/apps_overview'
2020-11-11 11:47:10 +01:00
---
2018-08-28 02:29:43 +02:00
2020-09-14 11:50:33 +02:00
One of the key feature of YunoHost is the ability to easily install applications which are then immediately usable. Example of applications include a blog system, a "cloud" (to host and sync files), a website, an RSS reader...
2018-08-28 02:29:43 +02:00
Applications can be installed and managed through the webadmin interface in 'Applications' or through commands of the `yunohost app` category.
2021-02-07 03:20:11 +01:00
The application catalog can be browsed in the webadmin (in Applications > Install) or [here](/apps).
2018-08-28 02:29:43 +02:00
! Be careful to stay reasonable on the number of installed applications. Each additional installation increases the attack surface and the risk of failure. Ideally, if you want to test, do it with another instance for example in [a virtual machine](/install/hardware:virtualbox).
Applications must be packaged manually by application packagers/maintainers. Apps can be integrated with YunoHost to support upgrades, backup/restore and LDAP/SSO integration among other things.
## Instructions after installation
Some applications need to give you instructions, URLs or credentials once they are installed. So remember to check the email of the first user account.
2020-09-14 11:50:33 +02:00
## Integration and quality levels
2018-08-28 02:29:43 +02:00
Automated tests are being run regularly to test the integration and quality of all apps who were declared to be 'working' by packagers. The result is a level between 0 and 8, whose meaning is detailed on [this page](/packaging_apps_levels). Some tests results may also be available [on this dashboard](https://dash.yunohost.org/appci/branch/stable).
By default, only applications of sufficient quality are offered. When the quality of an application drops, updates are put on hold and installation is no longer possible, until the problem is resolved.
2018-08-28 02:29:43 +02:00
2020-09-14 11:50:33 +02:00
## LDAP / SSO integration
2018-08-28 02:29:43 +02:00
Applications may support integration with the LDAP / Single Sign On system, such that users who connects to the user portal can be automatically logged in all those apps. Some applications however do not support this as it can be either not implemented in the upstream, or the package didn't work on this part yet. This information is usually available on the README of the application package.
2018-08-28 02:29:43 +02:00
2020-09-14 11:50:33 +02:00
## Multi-instance applications
2018-08-28 02:29:43 +02:00
Some applications support the ability to be installed several times (at different locations) ! To do so, just go another time in Applications > Install, and select again the application to install.
## Subpaths vs. individual domains per apps
In the context of YunoHost, it is quite common to have a single (or a few) domains on which several apps are installed in "subpaths", so that you end up with something like this:
```bash
yolo.com
├── /blog : Wordpress (a blog)
├── /cloud : Nextcloud (a cloud service)
├── /rss : TinyTiny RSS (a RSS reader)
├── /wiki : DokuWiki (a wiki)
```
Alternatively, you may choose to install each (or some) apps on a dedicated domain. Beyond the aesthetic, using sub-domains instead of sub-paths allows the possibility to move a service to another server more easily. Also, some applications may need an entire domain dedicated to them, for technical reasons. The disadvantage is that you have to add a new domain each time, and therefore potentially configure additional DNS records, restart the diagnostics and install a new Let's Encrypt certificate.
This might look prettier for end users, but is generally considered more complicated and less efficient in the context of YunoHost, since you need to add a new domain each time. Nevertheless, some apps might need an entire domain dedicated to them, for technical reasons.
If all apps from the previous example were installed on a separate domain, this would give something like this:
```bash
blog.yolo.com : Wordpress (a blog)
cloud.yolo.com : Nextcloud (a cloud service)
rss.yolo.com : TinyTiny RSS (a RSS reader)
wiki.yolo.com : DokuWiki (a wiki)
```
!!! Many applications integrate a functionality that allows you to change the URL of your application. This choice between subpath and subdomain can be reversed in some cases via a simple manipulation in the administration interface.
## Tile management
Web applications can provide tiles available from the user portal, it is possible to choose whether or not to display them and redefine the text via the web administration interface `Applications > APP name > Operations > Manage labels and tiles` or via the command line: `yunohost app change-label <app> "New text"`.
2020-09-14 11:50:33 +02:00
## User access management
2018-08-28 02:29:43 +02:00
2020-04-06 16:56:25 +02:00
Access to apps can be restricted to some users only. This can be configured via the webadmin in the [Groups and permissions panel](/groups_and_permissions), or similarly via the command-line subcategory `yunohost user permission`.
2018-08-28 02:29:43 +02:00
## Applications packaging
2018-08-28 02:29:43 +02:00
If you want to learn or contribute to app packaging, please check the [contributor documentation](/contributordoc).