mirror of
https://github.com/YunoHost-Apps/slingcode_ynh.git
synced 2024-09-03 20:25:55 +02:00
Éric Gaspar
GitHub
parent
b49475c343
commit
59c0d92c6e
14 changed files with 201 additions and 115 deletions
55
.github/ISSUE_TEMPLATE.md
vendored
Normal file
55
.github/ISSUE_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently.
|
||||
|
||||
---
|
||||
|
||||
**How to post a meaningful bug report**
|
||||
1. *Read this whole template first.*
|
||||
2. *Determine if you are on the right place:*
|
||||
- *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!*
|
||||
- *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.*
|
||||
- *When in doubt, post here and we will figure it out together.*
|
||||
3. *Delete the italic comments as you write over them below, and remove this guide.*
|
||||
---
|
||||
|
||||
### Describe the bug
|
||||
|
||||
*A clear and concise description of what the bug is.*
|
||||
|
||||
### Context
|
||||
|
||||
- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...*
|
||||
- YunoHost version: x.x.x
|
||||
- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...*
|
||||
- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes*
|
||||
- If yes, please explain:
|
||||
- Using, or trying to install package version/branch:
|
||||
- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`*
|
||||
|
||||
### Steps to reproduce
|
||||
|
||||
- *If you performed a command from the CLI, the command itself is enough. For example:*
|
||||
```sh
|
||||
sudo yunohost app install the_app
|
||||
```
|
||||
- *If you used the webadmin, please perform the equivalent command from the CLI first.*
|
||||
- *If the error occurs in your browser, explain what you did:*
|
||||
1. *Go to '...'*
|
||||
2. *Click on '...'*
|
||||
3. *Scroll down to '...'*
|
||||
4. *See error*
|
||||
|
||||
### Expected behavior
|
||||
|
||||
*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.*
|
||||
|
||||
### Logs
|
||||
|
||||
*When an operation fails, YunoHost provides a simple way to share the logs.*
|
||||
- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.*
|
||||
- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.*
|
||||
|
||||
*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)*
|
||||
|
||||
*If applicable and useful, add screenshots to help explain your problem.*
|
||||
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
## Problem
|
||||
|
||||
- *Description of why you made this PR*
|
||||
|
||||
## Solution
|
||||
|
||||
- *And how do you fix that problem*
|
||||
|
||||
## PR Status
|
||||
|
||||
- [ ] Code finished and ready to be reviewed/tested
|
||||
- [ ] The fix/enhancement were manually tested (if applicable)
|
||||
|
||||
## Automatic tests
|
||||
|
||||
Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization)
|
||||
56
README.md
56
README.md
|
|
@ -1,3 +1,8 @@
|
|||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Slingcode for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/slingcode)  
|
||||
|
|
@ -5,44 +10,43 @@
|
|||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allow you to install Slingcode 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.*
|
||||
> *This package allows you to install Slingcode quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Overview
|
||||
|
||||
Slingcode is a code editor contained in a single HTML file. Therefore, it has no server component, so all of your data is stored in your browser's cache. However, it is still possible to make web apps, run them, export them, and even share them using peer-to-peer.
|
||||
|
||||
**Shipped version:** 0.2.2
|
||||
### Features:
|
||||
|
||||
- You can make, run, and share web apps with it.
|
||||
- You don't need any complicated tools to use it, just a web browser.
|
||||
- You don't need a server, hosting, or an SSL certificate to run the web apps.
|
||||
- You can put Slingcode on a web site, run it from a USB stick, laptop, or phone, and it doesn't need an internet connection to work.
|
||||
- You can "add to home screen" in your phone's browser to easily access your library of programs on the go.
|
||||
- You can share apps peer-to-peer over WebTorrent.
|
||||
- It's private. You only share what you choose.
|
||||
|
||||
|
||||
**Shipped version:** 0.2.2~ynh4
|
||||
|
||||
**Demo:** https://slingcode.net/slingcode.html
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
## Demo
|
||||
|
||||
* [Official demo](https://slingcode.net/slingcode.html)
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://slingcode.net/screencasts.html
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/slingcode/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/slingcode/)
|
||||
|
||||
## Links
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: https://slingcode.net/
|
||||
* Official user documentation: https://slingcode.net/screencasts.html
|
||||
* Upstream app code repository: https://github.com/chr15m/slingcode
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_slingcode
|
||||
* Report a bug: https://github.com/YunoHost-Apps/slingcode_ynh/issues
|
||||
* App website: https://slingcode.net/
|
||||
* Upstream app repository: https://github.com/chr15m/slingcode
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
## Developer info
|
||||
|
||||
## Developers info
|
||||
|
||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/slingcode_ynh/tree/testing).
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/slingcode_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
|
|
@ -50,3 +54,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/slingcode_ynh/tree/te
|
|||
or
|
||||
sudo yunohost app upgrade slingcode -u https://github.com/YunoHost-Apps/slingcode_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
54
README_fr.md
54
README_fr.md
|
|
@ -1,44 +1,44 @@
|
|||
# Slingcode pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/slingcode)  
|
||||
[](https://install-app.yunohost.org/?app=slingcode)
|
||||
[](https://dash.yunohost.org/appci/app/slingcode)  
|
||||
[](https://install-app.yunohost.org/?app=slingcode)
|
||||
|
||||
*[Read this Slingcode in english.](./README.md)*
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d’installer Slingcode 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.*
|
||||
> *Ce package vous permet d'installer Slingcode 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
|
||||
## Vue d'ensemble
|
||||
|
||||
Slingcode est un éditeur de code contenu dans un unique fichier HTML. Il n'a pas de composant serveur, ce qui signifie que toutes vos données sont stockées dans le cache de votre navigateur. Cependant, il est toujours possible de créer des applications Web, de les exécuter, de les exporter et même de les partager en peer-to-peer.
|
||||
|
||||
**Version incluse :** 0.2.2
|
||||
### Caractéristiques:
|
||||
|
||||
## Captures d’écran
|
||||
- Vous pouvez créer, exécuter et partager des applications Web avec.
|
||||
- Vous n'avez pas besoin d'outils compliqués pour l'utiliser, juste un navigateur Web.
|
||||
- Vous n'avez pas besoin d'un serveur, d'un hébergement ou d'un certificat SSL pour exécuter les applications Web.
|
||||
- Vous pouvez mettre Slingcode sur un site Web, l'exécuter à partir d'une clé USB, d'un ordinateur portable ou d'un téléphone, et il n'a pas besoin d'une connexion Internet pour fonctionner.
|
||||
- Vous pouvez "ajouter à l'écran d'accueil" dans le navigateur de votre téléphone pour accéder facilement à votre bibliothèque de programmes lors de vos déplacements.
|
||||
- Vous pouvez partager des applications peer-to-peer sur WebTorrent.
|
||||
- C'est privé. Vous ne partagez que ce que vous choisissez.
|
||||
|
||||
|
||||
|
||||
## Démo
|
||||
**Version incluse :** 0.2.2~ynh4
|
||||
|
||||
* [Démo officielle](https://slingcode.net/slingcode.html)
|
||||
**Démo :** https://slingcode.net/slingcode.html
|
||||
|
||||
## Documentation
|
||||
## Captures d'écran
|
||||
|
||||
* Documentation officielle : https://slingcode.net/screencasts.html
|
||||
|
||||
|
||||
#### Architectures supportées
|
||||
## Documentations et ressources
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/slingcode/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/slingcode/)
|
||||
|
||||
## Liens
|
||||
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/slingcode_ynh/issues
|
||||
* Site de l'application : https://slingcode.net/
|
||||
* Dépôt de l’application principale : https://github.com/chr15m/slingcode
|
||||
* Site web YunoHost : https://yunohost.org/
|
||||
|
||||
---
|
||||
* Site officiel de l'app : https://slingcode.net/
|
||||
* Documentation officielle utilisateur : https://slingcode.net/screencasts.html
|
||||
* Dépôt de code officiel de l'app : https://github.com/chr15m/slingcode
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_slingcode
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/slingcode_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
|
|
@ -47,6 +47,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno
|
|||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/slingcode_ynh/tree/testing --debug
|
||||
or
|
||||
ou
|
||||
sudo yunohost app upgrade slingcode -u https://github.com/YunoHost-Apps/slingcode_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
|
|
@ -1,9 +1,9 @@
|
|||
;; Test complet
|
||||
auto_remove=1
|
||||
; Manifest
|
||||
domain="domain.tld" (DOMAIN)
|
||||
path="/path" (PATH)
|
||||
is_public=1 (PUBLIC|public=1|private=0)
|
||||
domain="domain.tld"
|
||||
path="/path"
|
||||
is_public=1
|
||||
; Checks
|
||||
pkg_linter=1
|
||||
setup_sub_dir=1
|
||||
|
|
|
|||
|
|
@ -15,5 +15,4 @@ location __PATH__/ {
|
|||
|
||||
# Include SSOWAT user panel.
|
||||
#include conf.d/yunohost_panel.conf.inc;
|
||||
|
||||
}
|
||||
|
|
|
|||
11
doc/DESCRIPTION.md
Normal file
11
doc/DESCRIPTION.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
Slingcode is a code editor contained in a single HTML file. Therefore, it has no server component, so all of your data is stored in your browser's cache. However, it is still possible to make web apps, run them, export them, and even share them using peer-to-peer.
|
||||
|
||||
### Features:
|
||||
|
||||
- You can make, run, and share web apps with it.
|
||||
- You don't need any complicated tools to use it, just a web browser.
|
||||
- You don't need a server, hosting, or an SSL certificate to run the web apps.
|
||||
- You can put Slingcode on a web site, run it from a USB stick, laptop, or phone, and it doesn't need an internet connection to work.
|
||||
- You can "add to home screen" in your phone's browser to easily access your library of programs on the go.
|
||||
- You can share apps peer-to-peer over WebTorrent.
|
||||
- It's private. You only share what you choose.
|
||||
11
doc/DESCRIPTION_fr.md
Normal file
11
doc/DESCRIPTION_fr.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
Slingcode est un éditeur de code contenu dans un unique fichier HTML. Il n'a pas de composant serveur, ce qui signifie que toutes vos données sont stockées dans le cache de votre navigateur. Cependant, il est toujours possible de créer des applications Web, de les exécuter, de les exporter et même de les partager en peer-to-peer.
|
||||
|
||||
### Caractéristiques:
|
||||
|
||||
- Vous pouvez créer, exécuter et partager des applications Web avec.
|
||||
- Vous n'avez pas besoin d'outils compliqués pour l'utiliser, juste un navigateur Web.
|
||||
- Vous n'avez pas besoin d'un serveur, d'un hébergement ou d'un certificat SSL pour exécuter les applications Web.
|
||||
- Vous pouvez mettre Slingcode sur un site Web, l'exécuter à partir d'une clé USB, d'un ordinateur portable ou d'un téléphone, et il n'a pas besoin d'une connexion Internet pour fonctionner.
|
||||
- Vous pouvez "ajouter à l'écran d'accueil" dans le navigateur de votre téléphone pour accéder facilement à votre bibliothèque de programmes lors de vos déplacements.
|
||||
- Vous pouvez partager des applications peer-to-peer sur WebTorrent.
|
||||
- C'est privé. Vous ne partagez que ce que vous choisissez.
|
||||
|
Before Width: | Height: | Size: 146 KiB After Width: | Height: | Size: 146 KiB |
|
|
@ -6,15 +6,22 @@
|
|||
"en": "Browser based code editor in a single HTML file",
|
||||
"fr": "Éditeur de code en ligne contenu dans un seul fichier HTML"
|
||||
},
|
||||
"url": "https://github.com/chr15m/slingcode",
|
||||
"version": "0.2.2~ynh3",
|
||||
"url": "https://slingcode.net/",
|
||||
"version": "0.2.2~ynh4",
|
||||
"upstream": {
|
||||
"license": "MIT",
|
||||
"website": "https://slingcode.net/",
|
||||
"demo": "https://slingcode.net/slingcode.html",
|
||||
"userdoc": "https://slingcode.net/screencasts.html",
|
||||
"code": "https://github.com/chr15m/slingcode"
|
||||
},
|
||||
"license": "MIT",
|
||||
"maintainer": {
|
||||
"name": "eric_G",
|
||||
"email": ""
|
||||
},
|
||||
"requirements": {
|
||||
"yunohost": ">= 4.1.7"
|
||||
"yunohost": ">= 4.2.4"
|
||||
},
|
||||
"multi_instance": true,
|
||||
"services": [
|
||||
|
|
|
|||
|
|
@ -1,16 +0,0 @@
|
|||
## Problem
|
||||
- *Description of why you made this PR*
|
||||
|
||||
## Solution
|
||||
- *And how do you fix that problem*
|
||||
|
||||
## PR Status
|
||||
- [ ] Code finished.
|
||||
- [ ] Tested with Package_check.
|
||||
- [ ] Fix or enhancement tested.
|
||||
- [ ] Upgrade from last version tested.
|
||||
- [ ] Can be reviewed and tested.
|
||||
|
||||
## Package_check results
|
||||
---
|
||||
* An automatic package_check will be launch at https://ci-apps-dev.yunohost.org/, when you add a specific comment to your Pull Request: "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!"*
|
||||
|
|
@ -46,6 +46,14 @@ ynh_script_progression --message="Storing installation settings..." --weight=2
|
|||
ynh_app_setting_set --app=$app --key=domain --value=$domain
|
||||
ynh_app_setting_set --app=$app --key=path --value=$path_url
|
||||
|
||||
#=================================================
|
||||
# CREATE DEDICATED USER
|
||||
#=================================================
|
||||
ynh_script_progression --message="Configuring system user..." --weight=1
|
||||
|
||||
# Create a system user
|
||||
ynh_system_user_create --username=$app --home_dir="$final_path"
|
||||
|
||||
#=================================================
|
||||
# STANDARD MODIFICATIONS
|
||||
#=================================================
|
||||
|
|
@ -58,6 +66,10 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path
|
|||
mkdir -p $final_path
|
||||
cp -a ../sources/slingcode.html $final_path/slingcode.html
|
||||
|
||||
chmod 750 "$final_path"
|
||||
chmod -R o-rwx "$final_path"
|
||||
chown -R $app:www-data "$final_path"
|
||||
|
||||
#=================================================
|
||||
# NGINX CONFIGURATION
|
||||
#=================================================
|
||||
|
|
@ -66,23 +78,6 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=2
|
|||
# Create a dedicated NGINX config
|
||||
ynh_add_nginx_config
|
||||
|
||||
#=================================================
|
||||
# CREATE DEDICATED USER
|
||||
#=================================================
|
||||
ynh_script_progression --message="Configuring system user..." --weight=1
|
||||
|
||||
# Create a system user
|
||||
ynh_system_user_create --username=$app
|
||||
|
||||
#=================================================
|
||||
# GENERIC FINALIZATION
|
||||
#=================================================
|
||||
# SECURE FILES AND DIRECTORIES
|
||||
#=================================================
|
||||
|
||||
# Set permissions to app files
|
||||
chown -R $app: $final_path
|
||||
|
||||
#=================================================
|
||||
# SETUP SSOWAT
|
||||
#=================================================
|
||||
|
|
|
|||
|
|
@ -31,8 +31,6 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
|||
#=================================================
|
||||
ynh_script_progression --message="Validating restoration parameters..." --weight=1
|
||||
|
||||
ynh_webpath_available --domain=$domain --path_url=$path_url \
|
||||
|| ynh_die --message="Path not available: ${domain}${path_url}"
|
||||
test ! -d $final_path \
|
||||
|| ynh_die --message="There is already a directory: $final_path "
|
||||
|
||||
|
|
@ -44,6 +42,14 @@ test ! -d $final_path \
|
|||
|
||||
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
|
||||
|
||||
#=================================================
|
||||
# RECREATE THE DEDICATED USER
|
||||
#=================================================
|
||||
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
|
||||
|
||||
# Create the dedicated user (if not existing)
|
||||
ynh_system_user_create --username=$app --home_dir="$final_path"
|
||||
|
||||
#=================================================
|
||||
# RESTORE THE APP MAIN DIR
|
||||
#=================================================
|
||||
|
|
@ -51,20 +57,9 @@ ynh_script_progression --message="Restoring $app main directory..." --weight=2
|
|||
|
||||
ynh_restore_file --origin_path="$final_path"
|
||||
|
||||
#=================================================
|
||||
# RECREATE THE DEDICATED USER
|
||||
#=================================================
|
||||
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
|
||||
|
||||
# Create the dedicated user (if not existing)
|
||||
ynh_system_user_create --username=$app
|
||||
|
||||
#=================================================
|
||||
# RESTORE USER RIGHTS
|
||||
#=================================================
|
||||
|
||||
# Restore permissions on app files
|
||||
chown -R $app: $final_path
|
||||
chmod 750 "$final_path"
|
||||
chmod -R o-rwx "$final_path"
|
||||
chown -R $app:www-data "$final_path"
|
||||
|
||||
#=================================================
|
||||
# GENERIC FINALIZATION
|
||||
|
|
|
|||
|
|
@ -43,6 +43,14 @@ if ynh_legacy_permissions_exists; then
|
|||
ynh_app_setting_delete --app=$app --key=is_public
|
||||
fi
|
||||
|
||||
#=================================================
|
||||
# CREATE DEDICATED USER
|
||||
#=================================================
|
||||
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
|
||||
|
||||
# Create a dedicated user (if not existing)
|
||||
ynh_system_user_create --username=$app --home_dir="$final_path"
|
||||
|
||||
#=================================================
|
||||
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
|
||||
#=================================================
|
||||
|
|
@ -70,6 +78,10 @@ then
|
|||
cp -a ../sources/slingcode.html $final_path/slingcode.html
|
||||
fi
|
||||
|
||||
chmod 750 "$final_path"
|
||||
chmod -R o-rwx "$final_path"
|
||||
chown -R $app:www-data "$final_path"
|
||||
|
||||
#=================================================
|
||||
# NGINX CONFIGURATION
|
||||
#=================================================
|
||||
|
|
@ -78,13 +90,6 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." -
|
|||
# Create a dedicated NGINX config
|
||||
ynh_add_nginx_config
|
||||
|
||||
#=================================================
|
||||
# SECURE FILES AND DIRECTORIES
|
||||
#=================================================
|
||||
|
||||
# Set permissions on app files
|
||||
chown -R $app: $final_path
|
||||
|
||||
#=================================================
|
||||
# RELOAD NGINX
|
||||
#=================================================
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue