Browse Source

Add README + fix install deps

master
Miraty 9 months ago
parent
commit
6ece69b62f
7 changed files with 78 additions and 115 deletions
  1. +21
    -39
      README.md
  2. +24
    -35
      README_fr.md
  3. +4
    -38
      manifest.json
  4. BIN
      screenshot.png
  5. +8
    -0
      scripts/install
  6. +19
    -0
      scripts/invidious-logrotate
  7. +2
    -3
      scripts/remove

+ 21
- 39
README.md View File

@@ -1,42 +1,32 @@
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
- Copy this app before working on it.
- Edit `conf/nginx.conf` file to match application prerequisites.
- Edit `manifest.json` with application specific information.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
- Add a `LICENSE` file for the package.
- Edit `README.md` and README_fr.md.
# Invidious for YunoHost

# Example app for YunoHost
**WORK IN PROGRESS**: this package is unstable, don't try to install it in production

[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
[![Integration level](https://dash.yunohost.org/integration/invidious.svg)](https://dash.yunohost.org/appci/app/invidious)
[![Install invidious with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=invidious)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.
> *This package allow you to install Invidious quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*

## Overview
Quick description of this app.

**Shipped version:** 1.0
An alternative Web interface for YouTube. Use YouTube with as few Google as possible.

**Shipped version:** 0.19.1

## Screenshots

![](Link to an screenshot for this app)
![](screenshot.png)

## Demo

* [Official demo](Link to a demo site for this app)

## Configuration

How to configure this app: by an admin panel, a plain file with SSH, or any other way.
* Official demo: [https://invidio.us](https://invidio.us)

## Documentation

* Official documentation: Link to the official documentation of this app
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
* Official documentation: [https://github.com/omarroth/invidious/wiki](https://github.com/omarroth/invidious/wiki)

## YunoHost specific features

@@ -47,38 +37,30 @@ Can the app be used by multiple users?

#### Supported architectures

* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/)
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/invidious%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/invidious/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/invidious%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/invidious/)
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/invidious%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/invidious/)

## Limitations

* Any known limitations.

## Additional information

* Other information you would add about this application

**More information on the documentation page:**
https://yunohost.org/packaging_apps
* This package require a dedicated root domain, eg. yt.domain.tld

## Links

* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
* App website: Link to the official website of this app
* YunoHost website: https://yunohost.org/
* Report a bug about this package: [https://code.antopie.org/miraty/invidious_ynh/issues](https://code.antopie.org/miraty/invidious_ynh/issues)
* Invidious repository: [https://github.com/omarroth/invidious](https://github.com/omarroth/invidious)
* YunoHost website: [https://yunohost.org/](https://yunohost.org/)

---

Developers info
----------------

**Only if you want to use a testing branch for coding, instead of merging directly into master.**
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
Please do your pull request to the [testing branch](https://code.antopie.org/miraty/invidious_ynh/src/branch/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
sudo yunohost app install https://code.antopie.org/miraty/invidious_ynh/src/branch/testing --debug
or
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
sudo yunohost app upgrade invidious -u https://code.antopie.org/miraty/invidious_ynh/src/branch/testing --debug
```

+ 24
- 35
README_fr.md View File

@@ -1,34 +1,32 @@
# App exemple pour YunoHost
# Invidious pour YunoHost

[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
**TRAVAIL EN COURS** : ce paquet est instable, n'essayez pas de l'installer en production

*[Read this readme in english.](./README.md)*
[![Integration level](https://dash.yunohost.org/integration/invidious.svg)](https://dash.yunohost.org/appci/app/invidious)
[![Install invidious with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=invidious)

> *Ce package vous permet d'installer REPLACEBYYOURAPP rapidement et simplement sur un serveur Yunohost.
*[Read this readme in english.](./README.md)*

> *Ce package vous permet d'installer Invidious rapidement et simplement sur un serveur Yunohost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*

## Vue d'ensemble
Description rapide de cette application.

**Version incluse:** 1.0
Une interface Web alternative pour YouTube. Utilisez YouTube avec le moins de Google possible.

**Version incluse:** 0.19.1

## Captures d'écran

![](Lien vers une capture d'écran pour cette application)
![](screenshot.png)

## Démo

* [Démo officielle](Lien vers un site de démonstration pour cette application)

## Configuration

Comment configurer cette application: via le panneau d'administration, un fichier brut en SSH ou tout autre moyen.
* Démo officielle : [https://invidio.us](https://invidio.us)

## Documentation

* Documentation officielle: Lien vers la documentation officielle de cette application
* Documentation YunoHost: Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
* Documentation officielle : [https://github.com/omarroth/invidious/wiki](https://github.com/omarroth/invidious/wiki)

## Caractéristiques spécifiques YunoHost

@@ -39,38 +37,29 @@ L'application peut-elle être utilisée par plusieurs utilisateurs?

#### Supported architectures

* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/)
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/invidious%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/invidious/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/invidious%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/invidious/)
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/invidious%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/invidious/)

## Limitations

* Limitations connues.

## Informations additionnelles

* Autres informations à ajouter sur cette application

**Plus d'informations sur la page de documentation:**
https://yunohost.org/packaging_apps
* Ce paquet a besoin d'un domaine dédié, par exemple yt.domaine.tld

## Links
## Liens

* Signaler un bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
* Site de l'application: Lien vers le site officiel de cette application
* Site web YunoHost: https://yunohost.org/
* Signaler un bug à propos de ce paquet: [https://code.antopie.org/miraty/invidious_ynh/issues](https://code.antopie.org/miraty/invidious_ynh/issues)
* Dépot d'Invidious : [https://github.com/omarroth/invidious](https://github.com/omarroth/invidious)
* Site Web de YunoHost : [https://yunohost.org/](https://yunohost.org/)

---

Informations pour les développeurs
----------------

**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.**
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
Merci de faire vos pull request sur la [branche testing](https://code.antopie.org/miraty/invidious_ynh/src/branch/testing).

Pour essayer la branche testing, procédez comme suit.
```
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
sudo yunohost app install https://code.antopie.org/miraty/invidious_ynh/src/branch/testing --debug
ou
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
sudo yunohost app upgrade invidious -u https://code.antopie.org/miraty/invidious_ynh/src/branch/testing --debug
```

+ 4
- 38
manifest.json View File

@@ -37,21 +37,11 @@
"name": "path",
"type": "path",
"ask": {
"en": "Choose a path for Invidious",
"fr": "Choisissez un chemin pour Invidious"
"en": "Choose a path for Invidious (works only with /)",
"fr": "Choisissez un chemin pour Invidious (fonctionne seulement avec /)"
},
"example": "/invidious",
"default": "/invidious"
},
{
"name": "admin",
"type": "user",
"ask": {
"en": "Choose an admin user",
"fr": "Choisissez l’administrateur"
},
"example": "chnorris",
"default": "miraty"
"example": "/",
"default": "/"
},
{
"name": "is_public",
@@ -61,30 +51,6 @@
"fr": "Est-ce une application publique ?"
},
"default": true
},
{
"name": "language",
"type": "string",
"ask": {
"en": "Choose the application language",
"fr": "Choisissez la langue de l'application"
},
"choices": ["fr", "en"],
"default": "fr"
},
{
"name": "password",
"type": "password",
"ask": {
"en": "Set the administrator password",
"fr": "Définissez le mot de passe administrateur"
},
"help": {
"en": "Use the help field to add an information for the admin about this question.",
"fr": "Utilisez le champ aide pour ajouter une information à l'intention de l'administrateur à propos de cette question."
},
"example": "Choose a password",
"default": "ezaruioezcahxaufkejhvbzft"
}
]
}


BIN
screenshot.png View File

Before After
Width: 1600  |  Height: 900  |  Size: 889KB

+ 8
- 0
scripts/install View File

@@ -101,6 +101,11 @@ ynh_print_info "Installing dependencies..."
### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
### - And the section "UPGRADE DEPENDENCIES" in the upgrade script

# Add repository for installing crystal :
curl -sL "https://keybase.io/crystal/pgp_keys.asc" | sudo apt-key add -
echo "deb https://dist.crystal-lang.org/apt crystal main" | sudo tee /etc/apt/sources.list.d/crystal.list
sudo apt-get update

ynh_install_app_dependencies $pkg_dependencies

#=================================================
@@ -215,6 +220,9 @@ ynh_print_info "Configuring a systemd service..."
# Create a dedicated systemd config
ynh_add_systemd_config

# Start this new services
ynh_systemd_action

#=================================================
# SETUP APPLICATION WITH CURL
#=================================================


+ 19
- 0
scripts/invidious-logrotate View File

@@ -0,0 +1,19 @@
/var/log/invidious/*.log {
# Rotate if the logfile exceeds 100Mo
size 100M
# Keep 12 old log maximum
rotate 12
# Compress the logs with gzip
compress
# Compress the log at the next cycle. So keep always 2 non compressed logs
delaycompress
# Copy and truncate the log to allow to continue write on it. Instead of move the log.
copytruncate
# Do not do an error if the log is missing
missingok
# Not rotate if the log is empty
notifempty
# Keep old logs in the same dir
noolddir
}

+ 2
- 3
scripts/remove View File

@@ -57,9 +57,6 @@ ynh_remove_systemd_config
ynh_print_info "Removing the PostgreSQL database"

ynh_psql_remove_db --db_user=kemal --db_name=invidious
ynh_psql_remove_db --db_user=invidious --db_name=invidious
ynh_psql_remove_db --db_user=kemal --db_name=kemal
ynh_psql_remove_db --db_user=invidious --db_name=kemal

#=================================================
# REMOVE DEPENDENCIES
@@ -69,6 +66,8 @@ ynh_print_info "Removing dependencies"
# Remove metapackage and its dependencies
ynh_remove_app_dependencies

rm /etc/apt/sources.list.d/crystal.list

#=================================================
# REMOVE APP MAIN DIR
#=================================================


Loading…
Cancel
Save