Browse Source

Add README + fix install deps

master
Miraty 1 month 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 @@
1
-# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
2
-- Copy this app before working on it.
3
-- Edit `conf/nginx.conf` file to match application prerequisites.
4
-- Edit `manifest.json` with application specific information.
5
-- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
6
-- Add a `LICENSE` file for the package.
7
-- Edit `README.md` and README_fr.md.
1
+# Invidious for YunoHost
8 2
 
9
-# Example app for YunoHost
3
+**WORK IN PROGRESS**: this package is unstable, don't try to install it in production
10 4
 
11
-[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)  
12
-[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
5
+[![Integration level](https://dash.yunohost.org/integration/invidious.svg)](https://dash.yunohost.org/appci/app/invidious)  
6
+[![Install invidious with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=invidious)
13 7
 
14 8
 *[Lire ce readme en français.](./README_fr.md)*
15 9
 
16
-> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.  
10
+> *This package allow you to install Invidious quickly and simply on a YunoHost server.  
17 11
 If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
18 12
 
19 13
 ## Overview
20
-Quick description of this app.
21 14
 
22
-**Shipped version:** 1.0
15
+An alternative Web interface for YouTube. Use YouTube with as few Google as possible.
16
+
17
+**Shipped version:** 0.19.1
23 18
 
24 19
 ## Screenshots
25 20
 
26
-![](Link to an screenshot for this app)
21
+![](screenshot.png)
27 22
 
28 23
 ## Demo
29 24
 
30
-* [Official demo](Link to a demo site for this app)
31
-
32
-## Configuration
33
-
34
-How to configure this app: by an admin panel, a plain file with SSH, or any other way.
25
+* Official demo: [https://invidio.us](https://invidio.us)
35 26
 
36 27
 ## Documentation
37 28
 
38
- * Official documentation: Link to the official documentation of this app
39
- * YunoHost documentation: If specific documentation is needed, feel free to contribute.
29
+ * Official documentation: [https://github.com/omarroth/invidious/wiki](https://github.com/omarroth/invidious/wiki)
40 30
 
41 31
 ## YunoHost specific features
42 32
 
@@ -47,38 +37,30 @@ Can the app be used by multiple users?
47 37
 
48 38
 #### Supported architectures
49 39
 
50
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
51
-* 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/)
52
-* 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/)
40
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/invidious%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/invidious/)
41
+* 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/)
42
+* 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/)
53 43
 
54 44
 ## Limitations
55 45
 
56
-* Any known limitations.
57
-
58
-## Additional information
59
-
60
-* Other information you would add about this application
61
-
62
-**More information on the documentation page:**  
63
-https://yunohost.org/packaging_apps
46
+* This package require a dedicated root domain, eg. yt.domain.tld
64 47
 
65 48
 ## Links
66 49
 
67
- * Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
68
- * App website: Link to the official website of this app
69
- * YunoHost website: https://yunohost.org/
50
+ * Report a bug about this package: [https://code.antopie.org/miraty/invidious_ynh/issues](https://code.antopie.org/miraty/invidious_ynh/issues)
51
+ * Invidious repository: [https://github.com/omarroth/invidious](https://github.com/omarroth/invidious)
52
+ * YunoHost website: [https://yunohost.org/](https://yunohost.org/)
70 53
 
71 54
 ---
72 55
 
73 56
 Developers info
74 57
 ----------------
75 58
 
76
-**Only if you want to use a testing branch for coding, instead of merging directly into master.**
77
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
59
+Please do your pull request to the [testing branch](https://code.antopie.org/miraty/invidious_ynh/src/branch/testing).
78 60
 
79 61
 To try the testing branch, please proceed like that.
80 62
 ```
81
-sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
63
+sudo yunohost app install https://code.antopie.org/miraty/invidious_ynh/src/branch/testing --debug
82 64
 or
83
-sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
65
+sudo yunohost app upgrade invidious -u https://code.antopie.org/miraty/invidious_ynh/src/branch/testing --debug
84 66
 ```

+ 24
- 35
README_fr.md View File

@@ -1,34 +1,32 @@
1
-# App exemple pour YunoHost
1
+# Invidious pour YunoHost
2 2
 
3
-[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)  
4
-[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
3
+**TRAVAIL EN COURS** : ce paquet est instable, n'essayez pas de l'installer en production
5 4
 
6
-*[Read this readme in english.](./README.md)* 
5
+[![Integration level](https://dash.yunohost.org/integration/invidious.svg)](https://dash.yunohost.org/appci/app/invidious)  
6
+[![Install invidious with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=invidious)
7 7
 
8
-> *Ce package vous permet d'installer REPLACEBYYOURAPP rapidement et simplement sur un serveur Yunohost.  
8
+*[Read this readme in english.](./README.md)*
9
+
10
+> *Ce package vous permet d'installer Invidious rapidement et simplement sur un serveur Yunohost.  
9 11
 Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
10 12
 
11 13
 ## Vue d'ensemble
12
-Description rapide de cette application.
13 14
 
14
-**Version incluse:** 1.0
15
+Une interface Web alternative pour YouTube. Utilisez YouTube avec le moins de Google possible.
16
+
17
+**Version incluse:** 0.19.1
15 18
 
16 19
 ## Captures d'écran
17 20
 
18
-![](Lien vers une capture d'écran pour cette application)
21
+![](screenshot.png)
19 22
 
20 23
 ## Démo
21 24
 
22
-* [Démo officielle](Lien vers un site de démonstration pour cette application)
23
-
24
-## Configuration
25
-
26
-Comment configurer cette application: via le panneau d'administration, un fichier brut en SSH ou tout autre moyen.
25
+* Démo officielle : [https://invidio.us](https://invidio.us)
27 26
 
28 27
 ## Documentation
29 28
 
30
- * Documentation officielle: Lien vers la documentation officielle de cette application
31
- * Documentation YunoHost: Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
29
+ * Documentation officielle : [https://github.com/omarroth/invidious/wiki](https://github.com/omarroth/invidious/wiki)
32 30
 
33 31
 ## Caractéristiques spécifiques YunoHost
34 32
 
@@ -39,38 +37,29 @@ L'application peut-elle être utilisée par plusieurs utilisateurs?
39 37
 
40 38
 #### Supported architectures
41 39
 
42
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
43
-* 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/)
44
-* 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/)
40
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/invidious%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/invidious/)
41
+* 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/)
42
+* 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/)
45 43
 
46 44
 ## Limitations
47 45
 
48
-* Limitations connues.
49
-
50
-## Informations additionnelles
51
-
52
-* Autres informations à ajouter sur cette application
53
-
54
-**Plus d'informations sur la page de documentation:**  
55
-https://yunohost.org/packaging_apps
46
+* Ce paquet a besoin d'un domaine dédié, par exemple yt.domaine.tld
56 47
 
57
-## Links
48
+## Liens
58 49
 
59
- * Signaler un bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
60
- * Site de l'application: Lien vers le site officiel de cette application
61
- * Site web YunoHost: https://yunohost.org/
50
+* Signaler un bug à propos de ce paquet: [https://code.antopie.org/miraty/invidious_ynh/issues](https://code.antopie.org/miraty/invidious_ynh/issues)
51
+* Dépot d'Invidious : [https://github.com/omarroth/invidious](https://github.com/omarroth/invidious)
52
+* Site Web de YunoHost : [https://yunohost.org/](https://yunohost.org/)
62 53
 
63 54
 ---
64 55
 
65 56
 Informations pour les développeurs
66 57
 ----------------
67 58
 
68
-**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.**
69
-Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
59
+Merci de faire vos pull request sur la [branche testing](https://code.antopie.org/miraty/invidious_ynh/src/branch/testing).
70 60
 
71
-Pour essayer la branche testing, procédez comme suit.
72 61
 ```
73
-sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
62
+sudo yunohost app install https://code.antopie.org/miraty/invidious_ynh/src/branch/testing --debug
74 63
 ou
75
-sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
64
+sudo yunohost app upgrade invidious -u https://code.antopie.org/miraty/invidious_ynh/src/branch/testing --debug
76 65
 ```

+ 4
- 38
manifest.json View File

@@ -37,21 +37,11 @@
37 37
                 "name": "path",
38 38
                 "type": "path",
39 39
                 "ask": {
40
-                    "en": "Choose a path for Invidious",
41
-                    "fr": "Choisissez un chemin pour Invidious"
40
+                    "en": "Choose a path for Invidious (works only with /)",
41
+                    "fr": "Choisissez un chemin pour Invidious (fonctionne seulement avec /)"
42 42
                 },
43
-                "example": "/invidious",
44
-                "default": "/invidious"
45
-            },
46
-            {
47
-                "name": "admin",
48
-                "type": "user",
49
-                "ask": {
50
-                    "en": "Choose an admin user",
51
-                    "fr": "Choisissez l’administrateur"
52
-                },
53
-                "example": "chnorris",
54
-                "default": "miraty"
43
+                "example": "/",
44
+                "default": "/"
55 45
             },
56 46
             {
57 47
                 "name": "is_public",
@@ -61,30 +51,6 @@
61 51
                     "fr": "Est-ce une application publique ?"
62 52
                 },
63 53
                 "default": true
64
-            },
65
-            {
66
-                "name": "language",
67
-                "type": "string",
68
-                "ask": {
69
-                    "en": "Choose the application language",
70
-                    "fr": "Choisissez la langue de l'application"
71
-                },
72
-                "choices": ["fr", "en"],
73
-                "default": "fr"
74
-            },
75
-            {
76
-                "name": "password",
77
-                "type": "password",
78
-                "ask": {
79
-                    "en": "Set the administrator password",
80
-                    "fr": "Définissez le mot de passe administrateur"
81
-                },
82
-                "help": {
83
-                    "en": "Use the help field to add an information for the admin about this question.",
84
-                    "fr": "Utilisez le champ aide pour ajouter une information à l'intention de l'administrateur à propos de cette question."
85
-                },
86
-                "example": "Choose a password",
87
-                "default": "ezaruioezcahxaufkejhvbzft"
88 54
             }
89 55
         ]
90 56
     }

BIN
screenshot.png View File


+ 8
- 0
scripts/install View File

@@ -101,6 +101,11 @@ ynh_print_info "Installing dependencies..."
101 101
 ###		- As well as the section "REINSTALL DEPENDENCIES" in the restore script
102 102
 ###		- And the section "UPGRADE DEPENDENCIES" in the upgrade script
103 103
 
104
+# Add repository for installing crystal :
105
+curl -sL "https://keybase.io/crystal/pgp_keys.asc" | sudo apt-key add -
106
+echo "deb https://dist.crystal-lang.org/apt crystal main" | sudo tee /etc/apt/sources.list.d/crystal.list
107
+sudo apt-get update
108
+
104 109
 ynh_install_app_dependencies $pkg_dependencies
105 110
 
106 111
 #=================================================
@@ -215,6 +220,9 @@ ynh_print_info "Configuring a systemd service..."
215 220
 # Create a dedicated systemd config
216 221
 ynh_add_systemd_config
217 222
 
223
+# Start this new services
224
+ynh_systemd_action
225
+
218 226
 #=================================================
219 227
 # SETUP APPLICATION WITH CURL
220 228
 #=================================================

+ 19
- 0
scripts/invidious-logrotate View File

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

+ 2
- 3
scripts/remove View File

@@ -57,9 +57,6 @@ ynh_remove_systemd_config
57 57
 ynh_print_info "Removing the PostgreSQL database"
58 58
 
59 59
 ynh_psql_remove_db --db_user=kemal --db_name=invidious
60
-ynh_psql_remove_db --db_user=invidious --db_name=invidious
61
-ynh_psql_remove_db --db_user=kemal --db_name=kemal
62
-ynh_psql_remove_db --db_user=invidious --db_name=kemal
63 60
 
64 61
 #=================================================
65 62
 # REMOVE DEPENDENCIES
@@ -69,6 +66,8 @@ ynh_print_info "Removing dependencies"
69 66
 # Remove metapackage and its dependencies
70 67
 ynh_remove_app_dependencies
71 68
 
69
+rm /etc/apt/sources.list.d/crystal.list
70
+
72 71
 #=================================================
73 72
 # REMOVE APP MAIN DIR
74 73
 #=================================================

Loading…
Cancel
Save