mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
Merge branch 'YunoHost:master' into master
This commit is contained in:
commit
508ac7c70d
9 changed files with 250 additions and 143 deletions
|
@ -57,6 +57,7 @@ ssh admin@domain.tld
|
||||||
Ensuite, mettre à jour les informations suivantes :
|
Ensuite, mettre à jour les informations suivantes :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
sudo yunohost settings set email.smtp.smtp_relay_enabled -v yes
|
||||||
sudo yunohost settings set smtp.relay.host -v smtprelay.tld
|
sudo yunohost settings set smtp.relay.host -v smtprelay.tld
|
||||||
sudo yunohost settings set smtp.relay.port -v 2525
|
sudo yunohost settings set smtp.relay.port -v 2525
|
||||||
sudo yunohost settings set smtp.relay.user -v username
|
sudo yunohost settings set smtp.relay.user -v username
|
||||||
|
|
|
@ -60,6 +60,7 @@ ssh admin@yourdomain.tld
|
||||||
Then you can update the three values as below:
|
Then you can update the three values as below:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
sudo yunohost settings set email.smtp.smtp_relay_enabled -v yes
|
||||||
sudo yunohost settings set smtp.relay.host -v smtprelay.tld
|
sudo yunohost settings set smtp.relay.host -v smtprelay.tld
|
||||||
sudo yunohost settings set smtp.relay.port -v 2525
|
sudo yunohost settings set smtp.relay.port -v 2525
|
||||||
sudo yunohost settings set smtp.relay.user -v username
|
sudo yunohost settings set smtp.relay.user -v username
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
title: Équivalence avec les applications Framasoft
|
title: Equivalent Framasoft applications
|
||||||
template: docs
|
template: docs
|
||||||
taxonomy:
|
taxonomy:
|
||||||
category: docs
|
category: docs
|
||||||
|
@ -7,7 +7,7 @@ routes:
|
||||||
default: '/apps_framasoft'
|
default: '/apps_framasoft'
|
||||||
---
|
---
|
||||||
|
|
||||||
| App Framasoft | Projet d'origine | Package |
|
| Framasoft App | Original project | Package |
|
||||||
| :---: | :---: | :---: |
|
| :---: | :---: | :---: |
|
||||||
| Framabag | [Wallabag ](https://www.wallabag.it) | [[fa=git /]](https://github.com/YunoHost-Apps/wallabag2_ynh)   |
|
| Framabag | [Wallabag ](https://www.wallabag.it) | [[fa=git /]](https://github.com/YunoHost-Apps/wallabag2_ynh)   |
|
||||||
| Framabee | [Searx ](https://searx.ir) | [[fa=git /]](https://github.com/YunoHost-Apps/searx_ynh)   |
|
| Framabee | [Searx ](https://searx.ir) | [[fa=git /]](https://github.com/YunoHost-Apps/searx_ynh)   |
|
||||||
|
@ -46,7 +46,7 @@ routes:
|
||||||
| Framinetest | [Minetest ](https://www.minetest.net) | [[fa=git /]](https://github.com/YunoHost-Apps/minetest_ynh)   |
|
| Framinetest | [Minetest ](https://www.minetest.net) | [[fa=git /]](https://github.com/YunoHost-Apps/minetest_ynh)   |
|
||||||
| MyFrama | [Shaarli ](https://github.com/shaarli/Shaarli) | [[fa=git /]](https://github.com/YunoHost-Apps/shaarli_ynh)   |
|
| MyFrama | [Shaarli ](https://github.com/shaarli/Shaarli) | [[fa=git /]](https://github.com/YunoHost-Apps/shaarli_ynh)   |
|
||||||
|
|
||||||
### Voir aussi
|
### See also
|
||||||
|
|
||||||
- [Liste complète des applications packagées](/apps)
|
- [Complete list of packaged applications](/apps)
|
||||||
- [La roadmap 'Dégooglisons'](https://github.com/YunoHost/issues/milestone/13)
|
- [The roadmap 'Dégooglisons'](https://github.com/YunoHost/issues/milestone/13)
|
|
@ -93,7 +93,7 @@ You can [contribute to this list by adding something you'd like to be packaged](
|
||||||
| [Federated wiki](http://fed.wiki.org/view/welcome-visitors/view/federated-wiki) | Farm for fedwiki sites | [Upstream](https://github.com/fedwiki) | |
|
| [Federated wiki](http://fed.wiki.org/view/welcome-visitors/view/federated-wiki) | Farm for fedwiki sites | [Upstream](https://github.com/fedwiki) | |
|
||||||
| [Ferdi server](https://getferdi.com) | Messaging aggregation | [Upstream](https://github.com/getferdi/server) | |
|
| [Ferdi server](https://getferdi.com) | Messaging aggregation | [Upstream](https://github.com/getferdi/server) | |
|
||||||
| [FEX](https://fex.rus.uni-stuttgart.de/) | | | |
|
| [FEX](https://fex.rus.uni-stuttgart.de/) | | | |
|
||||||
| [FIDI](https://docs.firefly-iii.org/data-importer) | Import data from banks to Firefly | | |
|
| [Firefly-III Data Importer](https://docs.firefly-iii.org/data-importer) | Import data from banks to Firefly | [Upstream](https://github.com/firefly-iii/data-importer) | [Draft Package](https://github.com/marcoil/firefly-iii-di_ynh) |
|
||||||
| [Filestash](https://www.filestash.app/) | | [Upstream](https://github.com/mickael-kerjean/filestash) | |
|
| [Filestash](https://www.filestash.app/) | | [Upstream](https://github.com/mickael-kerjean/filestash) | |
|
||||||
| [fishnet](https://lichess.org/get-fishnet) | Distributed Stockfish analysis for lichess.org | [Upstream](https://github.com/niklasf/fishnet) | |
|
| [fishnet](https://lichess.org/get-fishnet) | Distributed Stockfish analysis for lichess.org | [Upstream](https://github.com/niklasf/fishnet) | |
|
||||||
| FitTrackee | | [Upstream](https://github.com/SamR1/FitTrackee) | |
|
| FitTrackee | | [Upstream](https://github.com/SamR1/FitTrackee) | |
|
||||||
|
@ -134,6 +134,7 @@ You can [contribute to this list by adding something you'd like to be packaged](
|
||||||
| [Headscale](https://github.com/juanfont/headscale) | An open source, self-hosted implementation of the Tailscale Mesh-VPN control server | [Upstream Daemon](https://github.com/juanfont/headscale) [Upstream UI](https://github.com/gurucomputing/headscale-ui) | |
|
| [Headscale](https://github.com/juanfont/headscale) | An open source, self-hosted implementation of the Tailscale Mesh-VPN control server | [Upstream Daemon](https://github.com/juanfont/headscale) [Upstream UI](https://github.com/gurucomputing/headscale-ui) | |
|
||||||
| Helpy | | [Upstream](https://github.com/helpyio/helpy) | |
|
| Helpy | | [Upstream](https://github.com/helpyio/helpy) | |
|
||||||
| [Hexo](https://hexo.io/) | | [Upstream](https://github.com/hexojs/hexo) | |
|
| [Hexo](https://hexo.io/) | | [Upstream](https://github.com/hexojs/hexo) | |
|
||||||
|
| [HistoPad](https://github.com/24eme/histopad) | Web application for logging pads (etherpad) and archiving them in a git repository. | [Upstream](https://github.com/24eme/histopad) | |
|
||||||
| Hometown | A Mastodon fork with local-only posting, support for more content types, and other features and tweaks. | [Upstream](https://github.com/hometown-fork/hometown) | |
|
| Hometown | A Mastodon fork with local-only posting, support for more content types, and other features and tweaks. | [Upstream](https://github.com/hometown-fork/hometown) | |
|
||||||
| [htpc-manager](https://htpc.io) | Manage your HTPC from anywhere | | [Package Draft](https://github.com/scith/htpc-manager_ynh) |
|
| [htpc-manager](https://htpc.io) | Manage your HTPC from anywhere | | [Package Draft](https://github.com/scith/htpc-manager_ynh) |
|
||||||
| [Icecast 2](https://www.icecast.org) | | [Upstream](https://gitlab.xiph.org/xiph/icecast-server/) | |
|
| [Icecast 2](https://www.icecast.org) | | [Upstream](https://gitlab.xiph.org/xiph/icecast-server/) | |
|
||||||
|
@ -173,6 +174,7 @@ You can [contribute to this list by adding something you'd like to be packaged](
|
||||||
| [MaidSafe](https://maidsafe.net) | | [Upstream](https://github.com/maidsafe) | |
|
| [MaidSafe](https://maidsafe.net) | | [Upstream](https://github.com/maidsafe) | |
|
||||||
| [Mailpile](https://www.mailpile.is) | | [Upstream](https://github.com/mailpile/Mailpile) | |
|
| [Mailpile](https://www.mailpile.is) | | [Upstream](https://github.com/mailpile/Mailpile) | |
|
||||||
| [Mailtrain](https://mailtrain.org/) | | [Upstream](https://github.com/Mailtrain-org/mailtrain) | |
|
| [Mailtrain](https://mailtrain.org/) | | [Upstream](https://github.com/Mailtrain-org/mailtrain) | |
|
||||||
|
| [Maloja](https://maloja.krateng.ch) | Self-hosted music scrobble database, alternative to Last.fm | [Upstream](https://github.com/krateng/maloja) | |
|
||||||
| [Tileserver-GL](https://maps.earth/) | Tile server light SVG for map service | [Upstream](https://github.com/maptiler/tileserver-gl) | |
|
| [Tileserver-GL](https://maps.earth/) | Tile server light SVG for map service | [Upstream](https://github.com/maptiler/tileserver-gl) | |
|
||||||
| [Mealie](https://hay-kot.github.io/mealie/) | Recipe manager and meal planner | [Upstream](https://github.com/hay-kot/mealie/) | |
|
| [Mealie](https://hay-kot.github.io/mealie/) | Recipe manager and meal planner | [Upstream](https://github.com/hay-kot/mealie/) | |
|
||||||
| [Mediagoblin](https://mediagoblin.org/) | Video streaming platform | [Upstream](https://savannah.gnu.org/projects/mediagoblin) | [Package Draft](https://github.com/YunoHost-Apps/mediagoblin_ynh) |
|
| [Mediagoblin](https://mediagoblin.org/) | Video streaming platform | [Upstream](https://savannah.gnu.org/projects/mediagoblin) | [Package Draft](https://github.com/YunoHost-Apps/mediagoblin_ynh) |
|
||||||
|
@ -197,8 +199,7 @@ You can [contribute to this list by adding something you'd like to be packaged](
|
||||||
| [Nebula](https://nebula.defined.net/docs/) | Scalable overlay networking tool with a focus on performance, simplicity and security. | [Upstream](https://github.com/slackhq/nebula) | |
|
| [Nebula](https://nebula.defined.net/docs/) | Scalable overlay networking tool with a focus on performance, simplicity and security. | [Upstream](https://github.com/slackhq/nebula) | |
|
||||||
| Netrunner | | [Upstream](https://github.com/mtgred/netrunner) | |
|
| Netrunner | | [Upstream](https://github.com/mtgred/netrunner) | |
|
||||||
| [Netbird](https://netbird.io/) | Create an overlay peer-to-peer network connecting machines regardless of their location | [Upstream](https://github.com/netbirdio/netbird) | |
|
| [Netbird](https://netbird.io/) | Create an overlay peer-to-peer network connecting machines regardless of their location | [Upstream](https://github.com/netbirdio/netbird) | |
|
||||||
| [nostr] | | (https://nostr.com/) | The simplest open protocol that is able to create a censorship-resistant global "social" network once for all.
|
| [nostr](https://nostr.com/) | The simplest open protocol that is able to create a censorship-resistant global "social" network once for all. | [Upstream](https://github.com/nostr-protocol/nostr) ||
|
||||||
| [Upstream] (https://github.com/nostr-protocol/nostr) ||
|
|
||||||
| [Netlify CMS](https://netlifycms.org/) | A CMS for any static site generator that connects to a Gitlab/Github repo (requires netlify/gotrue) | [Upstream](https://github.com/netlify/netlify-cms) | |
|
| [Netlify CMS](https://netlifycms.org/) | A CMS for any static site generator that connects to a Gitlab/Github repo (requires netlify/gotrue) | [Upstream](https://github.com/netlify/netlify-cms) | |
|
||||||
| [NewsBlur](https://www.newsblur.com) | This is the most complete RSS reader that exists to date | [Upstream](https://github.com/samuelclay/NewsBlur) | |
|
| [NewsBlur](https://www.newsblur.com) | This is the most complete RSS reader that exists to date | [Upstream](https://github.com/samuelclay/NewsBlur) | |
|
||||||
| nexusoss | Sonatype Nexus Repository manager OSS | | [Package Draft](https://github.com/YunoHost-Apps/nexusoss_ynh) |
|
| nexusoss | Sonatype Nexus Repository manager OSS | | [Package Draft](https://github.com/YunoHost-Apps/nexusoss_ynh) |
|
||||||
|
@ -273,7 +274,6 @@ You can [contribute to this list by adding something you'd like to be packaged](
|
||||||
| [Screego](https://screego.net/) | Screen sharing webrtc | [Upstream](https://github.com/screego/server) | |
|
| [Screego](https://screego.net/) | Screen sharing webrtc | [Upstream](https://github.com/screego/server) | |
|
||||||
| [Scribe](https://scribe.rip/) | An alternative frontend to Medium | [Upstream](https://git.sr.ht/~edwardloveall/scribe) | |
|
| [Scribe](https://scribe.rip/) | An alternative frontend to Medium | [Upstream](https://git.sr.ht/~edwardloveall/scribe) | |
|
||||||
| [Scuttlebutt Pub](https://www.scuttlebutt.nz/contributing) | | | |
|
| [Scuttlebutt Pub](https://www.scuttlebutt.nz/contributing) | | | |
|
||||||
| [SearXNG](https://searxng.github.io/searxng/) | Fork of SearX, a privacy-respecting metasearch engine | [Upstream](https://github.com/searxng/searxng) | |
|
|
||||||
| [seenthis](https://www.seenthis.net/) | Short-blogging destiné à la veille d’actualité | | [Package Draft](https://github.com/magikcypress/seenthis_ynh) |
|
| [seenthis](https://www.seenthis.net/) | Short-blogging destiné à la veille d’actualité | | [Package Draft](https://github.com/magikcypress/seenthis_ynh) |
|
||||||
| [Semantic MediaWiki](https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki) | lets you store and query data within the [MediaWiki](https://en.wikipedia.org/wiki/MediaWiki)'s pages | [Upstream](https://github.com/SemanticMediaWiki/SemanticMediaWiki) | |
|
| [Semantic MediaWiki](https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki) | lets you store and query data within the [MediaWiki](https://en.wikipedia.org/wiki/MediaWiki)'s pages | [Upstream](https://github.com/SemanticMediaWiki/SemanticMediaWiki) | |
|
||||||
| [shadowsocks](https://shadowsocks.org) | A SOCKS5 proxy to protect your Internet traffic | | [Package Draft](https://github.com/YunoHost-Apps/shadowsocks_ynh) |
|
| [shadowsocks](https://shadowsocks.org) | A SOCKS5 proxy to protect your Internet traffic | | [Package Draft](https://github.com/YunoHost-Apps/shadowsocks_ynh) |
|
||||||
|
@ -330,7 +330,7 @@ You can [contribute to this list by adding something you'd like to be packaged](
|
||||||
| [ultrasonics](https://github.com/XDGFX/ultrasonics) | Sync music playlists between all your music services: Spotify, Deezer, Apple Music, Plex, etc. | [Upstream](https://github.com/XDGFX/ultrasonics) | |
|
| [ultrasonics](https://github.com/XDGFX/ultrasonics) | Sync music playlists between all your music services: Spotify, Deezer, Apple Music, Plex, etc. | [Upstream](https://github.com/XDGFX/ultrasonics) | |
|
||||||
| [umap](https://umap.openstreetmap.fr/) | Cartography software | | [Package Draft](https://github.com/YunoHost-Apps/umap_ynh) |
|
| [umap](https://umap.openstreetmap.fr/) | Cartography software | | [Package Draft](https://github.com/YunoHost-Apps/umap_ynh) |
|
||||||
| [unbound](https://nlnetlabs.nl/projects/unbound/about/) | | | [Package Draft](https://github.com/YunoHost-Apps/unbound_ynh) |
|
| [unbound](https://nlnetlabs.nl/projects/unbound/about/) | | | [Package Draft](https://github.com/YunoHost-Apps/unbound_ynh) |
|
||||||
| [upmpdcli](https://www.lesbonscomptes.com/upmpdcli/) | | [Upstream](https://framagit.org/medoc92/upmpdcli) | |
|
| [upmpdcli](https://www.lesbonscomptes.com/upmpdcli/) | UPNP-server and -renderer. Serves local files, internet-radio (radio-browser.info), BBC-Radio, Deezer, HighresAudio, Qobuz, Spotify and Tidal | [Upstream](https://framagit.org/medoc92/upmpdcli) | |
|
||||||
| [Uwazi](https://www.uwazi.io/) | | [Upstream](https://github.com/huridocs/uwazi) | |
|
| [Uwazi](https://www.uwazi.io/) | | [Upstream](https://github.com/huridocs/uwazi) | |
|
||||||
| [Volumio](https://volumio.org) | | [Upstream](https://github.com/volumio) | |
|
| [Volumio](https://volumio.org) | | [Upstream](https://github.com/volumio) | |
|
||||||
| [vpnserver](https://openvpn.net) | Create/provide VPNs from your server | | [Package Draft](https://github.com/YunoHost-Apps/vpnserver_ynh) |
|
| [vpnserver](https://openvpn.net) | Create/provide VPNs from your server | | [Package Draft](https://github.com/YunoHost-Apps/vpnserver_ynh) |
|
||||||
|
|
|
@ -8,7 +8,6 @@ routes:
|
||||||
---
|
---
|
||||||
|
|
||||||
Here comes the time:
|
Here comes the time:
|
||||||
- you know all the [YEPs](/packaging_apps_guidelines)
|
|
||||||
- you masterise [apps packaging](/packaging_apps), [package_check](https://github.com/YunoHost/package_check), [example_ynh](https://github.com/YunoHost/example_ynh) and [experimental helpers](https://github.com/YunoHost-Apps/Experimental_helpers)
|
- you masterise [apps packaging](/packaging_apps), [package_check](https://github.com/YunoHost/package_check), [example_ynh](https://github.com/YunoHost/example_ynh) and [experimental helpers](https://github.com/YunoHost-Apps/Experimental_helpers)
|
||||||
- you have integrated the [YunoHost Apps Group](https://yunohost.org/#/project_organization)
|
- you have integrated the [YunoHost Apps Group](https://yunohost.org/#/project_organization)
|
||||||
- you know what means `¯\_(ツ)_/¯`
|
- you know what means `¯\_(ツ)_/¯`
|
||||||
|
|
|
@ -80,7 +80,7 @@ Lors de la création d'une pull request à partir d'un fork, pour faciliter le t
|
||||||
|
|
||||||
#### Organisation YunoHost-Apps
|
#### Organisation YunoHost-Apps
|
||||||
|
|
||||||
Conformément à la [YEP 1.7](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines.md#yep-17), votre application doit être intégrée à l'organisation YunoHost-Apps, mais si vous n'avez jamais contribué à une application auparavant ou si vous n'avez jamais eu d'application dans cette organisation, vous n'en aurez peut-être pas l'autorisation.
|
Conformément au [guide de création d'applications dans YunoHost](/packaging_apps_intro), votre application doit être intégrée à l'organisation YunoHost-Apps, mais si vous n'avez jamais contribué à une application auparavant ou si vous n'avez jamais eu d'application dans cette organisation, vous n'en aurez peut-être pas l'autorisation.
|
||||||
|
|
||||||
Tout d'abord, vous devez avoir la permission d'écrire dans l'organisation, pour ce faire, demandez au groupe Apps sur le salon XMPP Apps.
|
Tout d'abord, vous devez avoir la permission d'écrire dans l'organisation, pour ce faire, demandez au groupe Apps sur le salon XMPP Apps.
|
||||||
|
|
||||||
|
|
|
@ -80,7 +80,7 @@ When creating a pull request from a fork, to ease the work of the reviewers, **d
|
||||||
|
|
||||||
#### YunoHost-Apps organization
|
#### YunoHost-Apps organization
|
||||||
|
|
||||||
Following the [YEP 1.7](https://github.com/YunoHost/doc/blob/master/packaging_apps_guidelines.md#yep-17), your app has to be into the YunoHost-Apps organization, but if you have never contributed to an app before or never had any app into this organization you may not have the permission.
|
Following the [guide for packaging application within YunoHost](/packaging_apps_intro), your app has to be into the YunoHost-Apps organization, but if you have never contributed to an app before or never had any app into this organization you may not have the permission.
|
||||||
|
|
||||||
First, you need the permission to write into the organization, to do so, ask to the Apps group on the Apps XMPP room.
|
First, you need the permission to write into the organization, to do so, ask to the Apps group on the Apps XMPP room.
|
||||||
|
|
||||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -7,7 +7,7 @@ routes:
|
||||||
default: '/packaging_apps_resources'
|
default: '/packaging_apps_resources'
|
||||||
---
|
---
|
||||||
|
|
||||||
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/5d1778211596d11600690d938df36a7a14527f27/doc/generate_resource_doc.py) on 24/02/2023 (YunoHost version ('11.1.11.2',))
|
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/f9a7016931de4293d4a7bcce3ff5357040356349/doc/generate_resource_doc.py) on 11/03/2023 (YunoHost version 11.1.15)
|
||||||
|
|
||||||
|
|
||||||
----------------
|
----------------
|
||||||
|
@ -210,6 +210,72 @@ xmpp_client.exposed = "TCP" # here, we're telling that the port needs to be publ
|
||||||
|
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
## Sources
|
||||||
|
|
||||||
|
Declare what are the sources / assets used by this app. Typically, this corresponds to some tarball published by the upstream project, that needs to be downloaded and extracted in the install dir using the ynh_setup_source helper.
|
||||||
|
|
||||||
|
This resource is intended both to declare the assets, which will be parsed by ynh_setup_source during the app script runtime, AND to prefetch and validate the sha256sum of those asset before actually running the script, to be able to report an error early when the asset turns out to not be available for some reason.
|
||||||
|
|
||||||
|
Various options are available to accomodate the behavior according to the asset structure
|
||||||
|
|
||||||
|
##### Example:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[resources.sources]
|
||||||
|
|
||||||
|
[resources.sources.main]
|
||||||
|
url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.tar.gz"
|
||||||
|
sha256 = "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
|
||||||
|
```
|
||||||
|
|
||||||
|
Or more complex examples with several element, including one with asset that depends on the arch
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[resources.sources]
|
||||||
|
|
||||||
|
[resources.sources.main]
|
||||||
|
in_subdir = false
|
||||||
|
amd64.url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.amd64.tar.gz"
|
||||||
|
amd64.sha256 = "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
|
||||||
|
i386.url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.amd64.tar.gz"
|
||||||
|
i386.sha256 = "53c234e5e8472b6ac51c1ae1cab3fe06fad053beb8ebfd8977b010655bfdd3c3"
|
||||||
|
armhf.url = "https://github.com/foo/bar/archive/refs/tags/v1.2.3.armhf.tar.gz"
|
||||||
|
armhf.sha256 = "4355a46b19d348dc2f57c046f8ef63d4538ebb936000f3c9ee954a27460dd865"
|
||||||
|
|
||||||
|
[resources.sources.zblerg]
|
||||||
|
url = "https://zblerg.com/download/zblerg"
|
||||||
|
sha256 = "1121cfccd5913f0a63fec40a6ffd44ea64f9dc135c66634ba001d10bcf4302a2"
|
||||||
|
format = "script"
|
||||||
|
rename = "zblerg.sh"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Properties (for each source):
|
||||||
|
|
||||||
|
- `prefetch` : `true` (default) or `false`, wether or not to pre-fetch this asset during the provisioning phase of the resource. If several arch-dependent url are provided, YunoHost will only prefetch the one for the current system architecture.
|
||||||
|
- `url` : the asset's URL
|
||||||
|
- If the asset's URL depend on the architecture, you may instead provide `amd64.url`, `i386.url`, `armhf.url` and `arm64.url` (depending on what architectures are supported), using the same `dpkg --print-architecture` nomenclature as for the supported architecture key in the manifest
|
||||||
|
- `sha256` : the asset's sha256sum. This is used both as an integrity check, and as a layer of security to protect against malicious actors which could have injected malicious code inside the asset...
|
||||||
|
- Same as `url` : if the asset's URL depend on the architecture, you may instead provide `amd64.sha256`, `i386.sha256`, ...
|
||||||
|
- `format` : The "format" of the asset. It is typically automatically guessed from the extension of the URL (or the mention of "tarball", "zipball" in the URL), but can be set explicitly:
|
||||||
|
- `tar.gz`, `tar.xz`, `tar.bz2` : will use `tar` to extract the archive
|
||||||
|
- `zip` : will use `unzip` to extract the archive
|
||||||
|
- `docker` : useful to extract files from an already-built docker image (instead of rebuilding them locally). Will use `docker-image-extract`
|
||||||
|
- `whatever`: whatever arbitrary value, not really meaningful except to imply that the file won't be extracted (eg because it's a .deb to be manually installed with dpkg/apt, or a script, or ...)
|
||||||
|
- `in_subdir`: `true` (default) or `false`, depending on if there's an intermediate subdir in the archive before accessing the actual files. Can also be `N` (an integer) to handle special cases where there's `N` level of subdir to get rid of to actually access the files
|
||||||
|
- `extract` : `true` or `false`. Defaults to `true` for archives such as `zip`, `tar.gz`, `tar.bz2`, ... Or defaults to `false` when `format` is not something that should be extracted. When `extract = false`, the file will only be `mv`ed to the location, possibly renamed using the `rename` value
|
||||||
|
- `rename`: some string like `whatever_your_want`, to be used for convenience when `extract` is `false` and the default name of the file is not practical
|
||||||
|
- `platform`: for example `linux/amd64` (defaults to `linux/$YNH_ARCH`) to be used in conjonction with `format = "docker"` to specify which architecture to extract for
|
||||||
|
|
||||||
|
|
||||||
|
##### Provision/Update:
|
||||||
|
- For elements with `prefetch = true`, will download the asset (for the appropriate architecture) and store them in `/var/cache/yunohost/download/$app/$source_id`, to be later picked up by `ynh_setup_source`. (NB: this only happens during install and upgrade, not restore)
|
||||||
|
|
||||||
|
##### Deprovision:
|
||||||
|
- Nothing (just cleanup the cache)
|
||||||
|
|
||||||
|
----------------
|
||||||
|
|
||||||
## System User
|
## System User
|
||||||
|
|
||||||
Provision a system user to be used by the app. The username is exactly equal to the app id
|
Provision a system user to be used by the app. The username is exactly equal to the app id
|
||||||
|
|
Loading…
Add table
Reference in a new issue