|
|
@@ -1,53 +1,39 @@
|
|
|
-# Packaging an app, starting from this example
|
|
|
-
|
|
|
-- (Alternatively to this small tutorial, consider checking out <https://appgenerator.yunohost.org> !)
|
|
|
-- Copy this app before working on it, using the ['Use this template'](https://github.com/new?template_name=example_ynh&template_owner=YunoHost) button on the Github repo
|
|
|
-- Edit the `manifest.toml` with app specific info
|
|
|
-- Edit the `install`, `upgrade`, `remove`, `backup` and `restore` scripts, and any relevant conf files in `conf/`
|
|
|
- - Using the [script helpers documentation](https://yunohost.org/packaging_apps_helpers)
|
|
|
-- Edit the `change_url` and `config` scripts too, or remove them if you have no use of them
|
|
|
-- Add a `LICENSE` file for the package.
|
|
|
- - NB: this `LICENSE` file is not meant to necessarily be the same LICENSE as the upstream app - it is only the LICENSE you want this package's code to published with and you can choose it freely! (If you don't know which to choose, we recommend [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt))
|
|
|
-- Edit files under the `doc/` directory ([see the page about documenting packages](https://yunohost.org/packaging_app_doc))
|
|
|
-- The `README.md` files are to be automatically generated by <https://github.com/YunoHost/apps_tools/blob/main/readme_generator>
|
|
|
-
|
|
|
----
|
|
|
<!--
|
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps_tools/blob/main/readme_generator>
|
|
|
It shall NOT be edited by hand.
|
|
|
-->
|
|
|
|
|
|
<h1>
|
|
|
- <img src="https://raw.githubusercontent.com/YunoHost/apps/main/logos/example.png" width="32px" alt="Logo of Example app">
|
|
|
- Example app, packaged for YunoHost
|
|
|
+ <img src="https://raw.githubusercontent.com/YunoHost/apps/main/logos/openwebui.png" width="32px" alt="Logo of Open WebUI">
|
|
|
+ Open WebUI, packaged for YunoHost
|
|
|
</h1>
|
|
|
|
|
|
-Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)
|
|
|
+User-friendly AI Interface (Supports Ollama, OpenAI API, ...)
|
|
|
|
|
|
[](https://example.com)
|
|
|
[](https://demo.example.com)
|
|
|
-[?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/example/)
|
|
|
+[?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/openwebui/)
|
|
|
|
|
|
<div align="center">
|
|
|
-<a href="https://apps.yunohost.org/app/example"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_more_info_on_the_appstore.svg"/></a>
|
|
|
-<a href="https://github.com/YunoHost-Apps/example_ynh/issues"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_report_an_issue.svg"/></a>
|
|
|
+<a href="https://apps.yunohost.org/app/openwebui"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_more_info_on_the_appstore.svg"/></a>
|
|
|
+<a href="https://github.com/YunoHost-Apps/openwebui_ynh/issues"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_report_an_issue.svg"/></a>
|
|
|
</div>
|
|
|
|
|
|
## 📦 Developer info
|
|
|
|
|
|
-[](https://ci-apps.yunohost.org/ci/apps/example/)
|
|
|
+[](https://ci-apps.yunohost.org/ci/apps/openwebui/)
|
|
|
|
|
|
-🛠️ Upstream Example app repository: <https://some.forge.com/example/example>
|
|
|
+🛠️ Upstream Open WebUI repository: <https://some.forge.com/example/example>
|
|
|
|
|
|
-Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
|
|
+Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/openwebui_ynh/tree/testing).
|
|
|
|
|
|
The `testing` branch can be tested using:
|
|
|
```
|
|
|
# fresh install:
|
|
|
-sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing
|
|
|
+sudo yunohost app install https://github.com/YunoHost-Apps/openwebui_ynh/tree/testing
|
|
|
|
|
|
# upgrade an existing install:
|
|
|
-sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing
|
|
|
+sudo yunohost app upgrade openwebui -u https://github.com/YunoHost-Apps/openwebui_ynh/tree/testing
|
|
|
```
|
|
|
|
|
|
### 📚 App packaging documentation
|