From Fedora Project Wiki
(it seems the package is called fedora-flathub-remote, not fedora-flathub-repository)
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Filtered Flathub Applications =
+
= Adding Selected Flathub Applications =
  
 
== Summary ==
 
== Summary ==
Enabling third-party repositories will now create a Flathub remote that is a filtered view of Flathub.
+
Enabling third-party repositories will now include selected Flathub applications via a filtered Flathub remote.
  
 
== Owner ==
 
== Owner ==
* Name: [[User:otaylor| Owen Taylor]]
+
* Name: [[User:otaylor| Owen Taylor]],  [[User:Ngompa|Neal Gompa]] [on behalf of the KDE SIG]
* Email: otaylor@redhat.com
+
* Email: otaylor@redhat.com, ngompa13@gmail.com
 
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
 
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
 
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
 
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
Line 12: Line 12:
  
 
== Current status ==
 
== Current status ==
[[Category:ChangePageIncomplete]]
+
[[Category:ChangeAcceptedF35]]
<!-- When your change proposal page is completed and ready for review and announcement -->
 
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
 
<!-- The Wrangler announces the Change to the devel-announce list and changes the category to Category:ChangeAnnounced (no action required) -->
 
<!-- After review, the Wrangler will move your page to Category:ChangeReadyForFesco... if it still needs more work it will move back to Category:ChangePageIncomplete-->
 
 
 
 
[[Category:SystemWideChange]]
 
[[Category:SystemWideChange]]
  
 
* Targeted release: [[Releases/F35 | Fedora Linux 35]]  
 
* Targeted release: [[Releases/F35 | Fedora Linux 35]]  
 
* Last updated: {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}  
 
* Last updated: {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}  
* FESCo issue: will be assigned by the Wrangler
+
* FESCo issue: [https://pagure.io/fesco/issue/2641 #2641]
* Tracker bug: will be assigned by the Wrangler
+
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=1982741 #1982741]
* Release notes tracker: will be assigned by the Wrangler
+
* Release notes tracker: [https://pagure.io/fedora-docs/release-notes/issue/717 #717]
  
 
== Detailed Description ==
 
== Detailed Description ==
 
'''''Note that this proposal is about user experience, procedures, and technology - the high-level concept has already been discussed and approved by the Fedora Council and FESCO.'''''
 
'''''Note that this proposal is about user experience, procedures, and technology - the high-level concept has already been discussed and approved by the Fedora Council and FESCO.'''''
  
Enabling third-party repositories will now create a Flathub remote that is a filtered view of Flathub. This means that applications on Flathub that have been explicitly approved (by a new process proposed here) will be available in GNOME Software and on the <code>flatpak</code> command line. If the user follows following the instructions on https://flatpak.org/setup/Fedora/, then the filter is removed, and the user gets a full view of Flathub.
+
Currently, Flathub applications are only available if the user manually installs Flathub.  With this change, enabling third-party repositories will add selected Flathub applications through a Flathub remote managed by the Fedora project. This means that applications on Flathub that have been explicitly approved (by a new process proposed here) will be available in GNOME Software and on the <code>flatpak</code> command line.  
 +
 
 +
Users may still install a completely unrestricted Flathub remote via the instructions on https://flatpak.org/setup/Fedora/, as they have been able to for several versions.  No changes are being made to the Flatpak binary already shipped by Fedora.
  
 
Roughly speaking, the criteria for including software is a) will not cause legal or other problems for Fedora to point to b) does not overlap Fedora Flatpaks or software in Fedora that could easily be made into a Flatpak c) works reasonably well. For Fedora 35, We expect to include all software from the top 50 most popular applications on Flathub that meet these criteria plus selected other software of interest to the Fedora target audience - Fedora community members are welcome to propose additions.
 
Roughly speaking, the criteria for including software is a) will not cause legal or other problems for Fedora to point to b) does not overlap Fedora Flatpaks or software in Fedora that could easily be made into a Flatpak c) works reasonably well. For Fedora 35, We expect to include all software from the top 50 most popular applications on Flathub that meet these criteria plus selected other software of interest to the Fedora target audience - Fedora community members are welcome to propose additions.
Line 75: Line 72:
  
 
* The <code>fedora-third-party</code> script added by [[Changes/Third_Party_Software_Mechanism]] will also include support for Flatpak repositories.
 
* The <code>fedora-third-party</code> script added by [[Changes/Third_Party_Software_Mechanism]] will also include support for Flatpak repositories.
* A new package <code>fedora-flathub-repository</code> will be added with a configuration file <code>/etc/fedora-third-party.d/flathub.conf</code> and a file <code>/etc/flatpak/filters/fedora-flathub.filter</code> that is referenced by the <code>flathub</code> remote when created.
+
* A new package <code>fedora-flathub-remote</code> will be added with a configuration file <code>/etc/fedora-third-party.d/flathub.conf</code> and a file <code>/etc/flatpak/filters/fedora-flathub.filter</code> that is referenced by the <code>flathub</code> remote when created.
 
* The filter is maintained by the scripts and procedures in https://pagure.io/fedora-flathub-filter/ - additions correspond to pull requests.
 
* The filter is maintained by the scripts and procedures in https://pagure.io/fedora-flathub-filter/ - additions correspond to pull requests.
 
* If the user explicitly installs Flathub, by, for example, following the instructions on https://flatpak.org/setup/Fedora/, then the filter is removed, and the user gets a full view of Flathub. (This is standard behavior already implemented in the Flatpak client)
 
* If the user explicitly installs Flathub, by, for example, following the instructions on https://flatpak.org/setup/Fedora/, then the filter is removed, and the user gets a full view of Flathub. (This is standard behavior already implemented in the Flatpak client)
Line 88: Line 85:
 
* Proposal owners
 
* Proposal owners
 
** Add flatpak support to the `fedora-third-party` script
 
** Add flatpak support to the `fedora-third-party` script
** Add a `fedora-flathub-repository` package that is built from the output of `fedora-flathub-filter` and integrates with the `fedora-third-party` repository package.  
+
** Add a `fedora-flathub-remote` package that is built from the output of `fedora-flathub-filter` and integrates with the `fedora-third-party` repository package.  
 
* Other developers:
 
* Other developers:
 
** No actions needed
 
** No actions needed
Line 115: Line 112:
  
 
== Contingency Plan ==
 
== Contingency Plan ==
* Contingency mechanism: remove the dependency of fedora-workstation-release on `fedora-flathub-repository`
+
* Contingency mechanism: remove the dependency of fedora-workstation-release on `fedora-flathub-remote`
 
* Contingency deadline: release candidate
 
* Contingency deadline: release candidate
 
* Blocks release? No - the contingency plan could be used at any point
 
* Blocks release? No - the contingency plan could be used at any point

Latest revision as of 08:18, 6 October 2021

Adding Selected Flathub Applications

Summary

Enabling third-party repositories will now include selected Flathub applications via a filtered Flathub remote.

Owner

Current status

Detailed Description

Note that this proposal is about user experience, procedures, and technology - the high-level concept has already been discussed and approved by the Fedora Council and FESCO.

Currently, Flathub applications are only available if the user manually installs Flathub. With this change, enabling third-party repositories will add selected Flathub applications through a Flathub remote managed by the Fedora project. This means that applications on Flathub that have been explicitly approved (by a new process proposed here) will be available in GNOME Software and on the flatpak command line.

Users may still install a completely unrestricted Flathub remote via the instructions on https://flatpak.org/setup/Fedora/, as they have been able to for several versions. No changes are being made to the Flatpak binary already shipped by Fedora.

Roughly speaking, the criteria for including software is a) will not cause legal or other problems for Fedora to point to b) does not overlap Fedora Flatpaks or software in Fedora that could easily be made into a Flatpak c) works reasonably well. For Fedora 35, We expect to include all software from the top 50 most popular applications on Flathub that meet these criteria plus selected other software of interest to the Fedora target audience - Fedora community members are welcome to propose additions.

Already reviewed: Zoom, Microsoft Teams, Skype, Bitwarden, Postman, Minecraft
Other likely software from the top 50: Discord, Anydesk, WPS Office, OnlyOffice, MasterPDFEditor, Slack, UngoogledChromium, Flatseal, WhatsAppQT, GreenWithEnvy

The expectation is that many included applications will be things that are hard or impossible to package in Fedora - proprietary applications, Electron-based applications, and so forth. This is consistent with the third-party software policy, and does not reflect a change from what we do currently with third-party repositories.

Fedora Workstation Issue: #108 Add selected Flathub apps to the third-party repos

Conformance to Fedora policies

The goal here is to be in conformance with the Fedora Third-Party Repository Policy. The current form of this policy was explicitly written and approved with the filtered view of Flathub being one of the use cases. See https://pagure.io/fesco/fesco-docs/pull-request/34

In detail, this proposal meets Key requirements for third-party repositories. We consider each application included in the filter as a separate "mini" repository

Third-party repositories must be approved by an active Fedora working group or SIG, or by FESCo. Groups who approve the inclusion of third party repositories must have a documented process which allows for community input, which produces a traceable history for each decision (for example, a ticket or other record).

The traceable process is filing a merge request to https://pagure.io/fedora-flathub-filter/

Additionally, repositories included in an edition or spin’s third-party repository list must conform to the following requirements:

  • Just as with any software hosted by Fedora, third party repositories must not contain material that poses an undue legal risk for the Fedora Project or its sponsors. This risk includes, but is not limited to, software with known patent issues, copyright issues, or software tailored for conducting illegal activities. Fedora working groups should evaluate if a proposed addition or provider poses a significant risk, and if in doubt, confer with Fedora Legal for advice.

This is done for each pull request to the fedora-flathub-filter repository.

  • Changes made by one Edition or spin should not impact other Fedora editions or spins.

Each spin has the ability to include filtered view of Flathub or not. We do not foresee having *separate* filters for different spins.

  • Working groups and SIGs should maintain oversight over the software that is made available through third-party repositories, to prevent unvetted software being made available to Fedora users. As part of this, third-party repositories should allow easy auditing by Fedora Legal. This requirement implies that third-party repositories should limit themselves to a small number of packages, or that measures should be put in place to define which packages are made available from a particular repository by default.

The filter is a "measure ... to define which packages are made available".

Technical implementation

  • The fedora-third-party script added by Changes/Third_Party_Software_Mechanism will also include support for Flatpak repositories.
  • A new package fedora-flathub-remote will be added with a configuration file /etc/fedora-third-party.d/flathub.conf and a file /etc/flatpak/filters/fedora-flathub.filter that is referenced by the flathub remote when created.
  • The filter is maintained by the scripts and procedures in https://pagure.io/fedora-flathub-filter/ - additions correspond to pull requests.
  • If the user explicitly installs Flathub, by, for example, following the instructions on https://flatpak.org/setup/Fedora/, then the filter is removed, and the user gets a full view of Flathub. (This is standard behavior already implemented in the Flatpak client)

Feedback

Benefit to Fedora

Fedora users who opt-in to third-party software repositories will have immediate access to more software out-of-the-box.

Scope

  • Proposal owners
    • Add flatpak support to the fedora-third-party script
    • Add a fedora-flathub-remote package that is built from the output of fedora-flathub-filter and integrates with the fedora-third-party repository package.
  • Other developers:
    • No actions needed
  • Release engineering: #10187
    • No actions needed
  • Policies and guidelines: N/A (not needed for this Change)
  • Trademark approval: N/A (not needed for this Change)
  • Alignment with Objectives: No significant alignment

Upgrade/compatibility impact

The expectation is that:

  • If the system already has a flathub remote installed, nothing happens, whether or not the user has opted-in to third-party software.
  • If the system does not have a flathub remote installed, and the user opts-in to third-party software at upgrade time, then the filtered-in apps are then available.

How To Test

  • On a fresh install or upgrade, if the user opts-in to third-party software, applications such as Skype are visible in GNOME Software and flatpak search.
  • On a fresh install or upgrade, if the user does not opt-in to third-party software, applications such as Skype are not visible in GNOME Software and flatpak search.
  • If https://flatpak.org/setup/Fedora/ is followed before upgrade, the remote remains unfiltered.
  • If https://flatpak.org/setup/Fedora/ is followed after upgrade, the remote becomes unfiltered.

User Experience

Fedora users who opt-in to third-party software repositories will have immediate access to more software out-of-the-box.

Dependencies

This depends on Changes/Third_Party_Software_Mechanism

Contingency Plan

  • Contingency mechanism: remove the dependency of fedora-workstation-release on fedora-flathub-remote
  • Contingency deadline: release candidate
  • Blocks release? No - the contingency plan could be used at any point

Documentation

The review process is described at https://pagure.io/fedora-flathub-filter/

Release Notes

With Fedora 35, if the user opts-in to third-party software repositories selected applications from https://flathub.org are now available by default in GNOME Software, in KDE Discover, and on the Flatpak command line.