mirror of
https://github.com/YunoHost-Apps/turtl_ynh.git
synced 2024-09-03 20:26:35 +02:00
yalh76
GitHub
commit
f7a826b2a5
31 changed files with 955 additions and 3087 deletions
55
.github/ISSUE_TEMPLATE.md
vendored
Executable file
55
.github/ISSUE_TEMPLATE.md
vendored
Executable 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
Executable file
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Executable 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)
|
||||||
136
.github/workflows/updater.sh
vendored
Executable file
136
.github/workflows/updater.sh
vendored
Executable file
|
|
@ -0,0 +1,136 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# PACKAGE UPDATING HELPER
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# This script is meant to be run by GitHub Actions
|
||||||
|
# The YunoHost-Apps organisation offers a template Action to run this script periodically
|
||||||
|
# Since each app is different, maintainers can adapt its contents so as to perform
|
||||||
|
# automatic actions when a new upstream release is detected.
|
||||||
|
|
||||||
|
# Remove this exit command when you are ready to run this Action
|
||||||
|
#exit 1
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# FETCHING LATEST RELEASE AND ITS ASSETS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Fetching information
|
||||||
|
current_version=$(cat manifest.json | jq -j '.version|split("~")[0]')
|
||||||
|
repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]')
|
||||||
|
# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions)
|
||||||
|
version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1)
|
||||||
|
assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'"))
|
||||||
|
|
||||||
|
# Later down the script, we assume the version has only digits and dots
|
||||||
|
# Sometimes the release name starts with a "v", so let's filter it out.
|
||||||
|
# You may need more tweaks here if the upstream repository has different naming conventions.
|
||||||
|
if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then
|
||||||
|
version=${version:1}
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Setting up the environment variables
|
||||||
|
echo "Current version: $current_version"
|
||||||
|
echo "Latest release from upstream: $version"
|
||||||
|
echo "VERSION=$version" >> $GITHUB_ENV
|
||||||
|
# For the time being, let's assume the script will fail
|
||||||
|
echo "PROCEED=false" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
# Proceed only if the retrieved version is greater than the current one
|
||||||
|
if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then
|
||||||
|
echo "::warning ::No new version available"
|
||||||
|
exit 0
|
||||||
|
# Proceed only if a PR for this new version does not already exist
|
||||||
|
elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then
|
||||||
|
echo "::warning ::A branch already exists for this update"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.)
|
||||||
|
echo "${#assets[@]} available asset(s)"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# UPDATE SOURCE FILES
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Here we use the $assets variable to get the resources published in the upstream release.
|
||||||
|
# Here is an example for Grav, it has to be adapted in accordance with how the upstream releases look like.
|
||||||
|
|
||||||
|
# Let's loop over the array of assets URLs
|
||||||
|
for asset_url in ${assets[@]}; do
|
||||||
|
|
||||||
|
echo "Handling asset at $asset_url"
|
||||||
|
|
||||||
|
# Assign the asset to a source file in conf/ directory
|
||||||
|
# Here we base the source file name upon a unique keyword in the assets url (admin vs. update)
|
||||||
|
# Leave $src empty to ignore the asset
|
||||||
|
case $asset_url in
|
||||||
|
*"admin"*)
|
||||||
|
src="app"
|
||||||
|
;;
|
||||||
|
*"update"*)
|
||||||
|
src="app-upgrade"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
src=""
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
# If $src is not empty, let's process the asset
|
||||||
|
if [ ! -z "$src" ]; then
|
||||||
|
|
||||||
|
# Create the temporary directory
|
||||||
|
tempdir="$(mktemp -d)"
|
||||||
|
|
||||||
|
# Download sources and calculate checksum
|
||||||
|
filename=${asset_url##*/}
|
||||||
|
curl --silent -4 -L $asset_url -o "$tempdir/$filename"
|
||||||
|
checksum=$(sha256sum "$tempdir/$filename" | head -c 64)
|
||||||
|
|
||||||
|
# Delete temporary directory
|
||||||
|
rm -rf $tempdir
|
||||||
|
|
||||||
|
# Get extension
|
||||||
|
if [[ $filename == *.tar.gz ]]; then
|
||||||
|
extension=tar.gz
|
||||||
|
else
|
||||||
|
extension=${filename##*.}
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Rewrite source file
|
||||||
|
cat <<EOT > conf/$src.src
|
||||||
|
SOURCE_URL=$asset_url
|
||||||
|
SOURCE_SUM=$checksum
|
||||||
|
SOURCE_SUM_PRG=sha256sum
|
||||||
|
SOURCE_FORMAT=$extension
|
||||||
|
SOURCE_IN_SUBDIR=true
|
||||||
|
SOURCE_FILENAME=
|
||||||
|
EOT
|
||||||
|
echo "... conf/$src.src updated"
|
||||||
|
|
||||||
|
else
|
||||||
|
echo "... asset ignored"
|
||||||
|
fi
|
||||||
|
|
||||||
|
done
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SPECIFIC UPDATE STEPS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Any action on the app's source code can be done.
|
||||||
|
# The GitHub Action workflow takes care of committing all changes after this script ends.
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# GENERIC FINALIZATION
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Replace new version in manifest
|
||||||
|
echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json
|
||||||
|
|
||||||
|
# No need to update the README, yunohost-bot takes care of it
|
||||||
|
|
||||||
|
# The Action will proceed only if the PROCEED environment variable is set to true
|
||||||
|
echo "PROCEED=true" >> $GITHUB_ENV
|
||||||
|
exit 0
|
||||||
72
README.md
72
README.md
|
|
@ -1,31 +1,67 @@
|
||||||
# Turtl app for YunoHost
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Turtl for YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/turtl)  
|
[](https://dash.yunohost.org/appci/app/turtl)  
|
||||||
|
[](https://install-app.yunohost.org/?app=turtl)
|
||||||
|
|
||||||
- [Yunohost project](https://yunohost.org)
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
- [Turtl website](https://turtlapp.com/)
|
|
||||||
|
|
||||||
.
|
> *This package allows you to install Turtl 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.*
|
||||||
|
|
||||||
**WARNING**: this is a work in progress, test it at your own risks!
|
## Overview
|
||||||
|
|
||||||
## Todo
|
Turtl is a free online service that allows you to create, synchronize and find your notes, in an encrypted manner.
|
||||||
|
|
||||||
- [ ] test on x86 (only tested on arm for now)
|
### Features
|
||||||
- [ ] upgrade script
|
|
||||||
- [ ] backup script
|
|
||||||
- [ ] restore script
|
|
||||||
- [ ] check_process
|
|
||||||
|
|
||||||
------------------------------
|
- Different note types: text, bookmark, password, image, and file/document
|
||||||
|
- Client-side cryptography to keep all of your data safe
|
||||||
|
- Securely share with anyone without compromising the security of your data
|
||||||
|
- Sharing allows different permissions ranging from read-only to full ownership of shared content
|
||||||
|
- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date
|
||||||
|
- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data.
|
||||||
|
- Browser extension makes bookmarking easy on desktop
|
||||||
|
- Share to Turtl on Android for easy bookmarking and file uploads
|
||||||
|
- Write notes in Markdown, an easy and natural way to format text
|
||||||
|
- TeX math expressions in notes for math people (surround them by $$ to use)
|
||||||
|
- Multiple translations (German, Spanish, French, and more)
|
||||||
|
- RTL text support for our Farsi/Hebrew/etc-speaking friends
|
||||||
|
- Export/import your entire profile for backup purposes or to move between servers
|
||||||
|
- Semi-offline mode (you only need to be connected to log in)
|
||||||
|
- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts)
|
||||||
|
- An open-source server allows you to host your own Turtl data
|
||||||
|
|
||||||
## What's Turtl
|
|
||||||
|
|
||||||
Turtl lets you take notes, bookmark websites, and store documents for sensitive projects.
|
**Shipped version:** 1.0~ynh1
|
||||||
From sharing passwords with your coworkers to tracking research on an article you're writing, Turtl keeps it all safe from everyone but you and those you share with.
|
|
||||||
|
|
||||||
You will need apps to use Turtl. Get them from <https://turtlapp.com/download/>.
|
|
||||||
|
|
||||||
## Nota bene
|
|
||||||
|
|
||||||
The `rethinkdb_2.3.6_armhf.deb` debian package in `conf` directory of this repository is a cross-compiled RethinkDB package for ARM architecture since no ARM package is provided by RethinkDB.
|
## Screenshots
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Documentation and resources
|
||||||
|
|
||||||
|
* Official app website: https://turtlapp.com
|
||||||
|
* Official admin documentation: https://turtlapp.com/docs/
|
||||||
|
* Upstream app code repository: https://github.com/turtl/server
|
||||||
|
* YunoHost documentation for this app: https://yunohost.org/app_turtl
|
||||||
|
* Report a bug: https://github.com/YunoHost-Apps/turtl_ynh/issues
|
||||||
|
|
||||||
|
## Developer info
|
||||||
|
|
||||||
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing).
|
||||||
|
|
||||||
|
To try the testing branch, please proceed like that.
|
||||||
|
```
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug
|
||||||
|
or
|
||||||
|
sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||||
63
README_fr.md
Normal file
63
README_fr.md
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
# Turtl pour YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/turtl)  
|
||||||
|
[](https://install-app.yunohost.org/?app=turtl)
|
||||||
|
|
||||||
|
*[Read this readme in english.](./README.md)*
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
|
> *Ce package vous permet d'installer Turtl 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
|
||||||
|
|
||||||
|
Turtl is a free online service that allows you to create, synchronize and find your notes, in an encrypted manner.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Different note types: text, bookmark, password, image, and file/document
|
||||||
|
- Client-side cryptography to keep all of your data safe
|
||||||
|
- Securely share with anyone without compromising the security of your data
|
||||||
|
- Sharing allows different permissions ranging from read-only to full ownership of shared content
|
||||||
|
- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date
|
||||||
|
- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data.
|
||||||
|
- Browser extension makes bookmarking easy on desktop
|
||||||
|
- Share to Turtl on Android for easy bookmarking and file uploads
|
||||||
|
- Write notes in Markdown, an easy and natural way to format text
|
||||||
|
- TeX math expressions in notes for math people (surround them by $$ to use)
|
||||||
|
- Multiple translations (German, Spanish, French, and more)
|
||||||
|
- RTL text support for our Farsi/Hebrew/etc-speaking friends
|
||||||
|
- Export/import your entire profile for backup purposes or to move between servers
|
||||||
|
- Semi-offline mode (you only need to be connected to log in)
|
||||||
|
- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts)
|
||||||
|
- An open-source server allows you to host your own Turtl data
|
||||||
|
|
||||||
|
|
||||||
|
**Version incluse :** 1.0~ynh1
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Captures d'écran
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Documentations et ressources
|
||||||
|
|
||||||
|
* Site officiel de l'app : https://turtlapp.com
|
||||||
|
* Documentation officielle de l'admin : https://turtlapp.com/docs/
|
||||||
|
* Dépôt de code officiel de l'app : https://github.com/turtl/server
|
||||||
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_turtl
|
||||||
|
* Signaler un bug : https://github.com/YunoHost-Apps/turtl_ynh/issues
|
||||||
|
|
||||||
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing).
|
||||||
|
|
||||||
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
|
```
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug
|
||||||
|
ou
|
||||||
|
sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||||
23
check_process
Normal file
23
check_process
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
;; Test complet
|
||||||
|
; Manifest
|
||||||
|
domain="domain.tld"
|
||||||
|
is_public=1
|
||||||
|
; Checks
|
||||||
|
pkg_linter=1
|
||||||
|
setup_sub_dir=0
|
||||||
|
setup_root=1
|
||||||
|
setup_nourl=0
|
||||||
|
setup_private=1
|
||||||
|
setup_public=1
|
||||||
|
upgrade=1
|
||||||
|
#upgrade=1 from_commit=CommitHash
|
||||||
|
backup_restore=1
|
||||||
|
multi_instance=0
|
||||||
|
port_already_use=0
|
||||||
|
change_url=0
|
||||||
|
;;; Options
|
||||||
|
Email=
|
||||||
|
Notification=none
|
||||||
|
;;; Upgrade options
|
||||||
|
; commit=CommitHash
|
||||||
|
name=Name and date of the commit.
|
||||||
7
conf/app.src
Normal file
7
conf/app.src
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
SOURCE_URL=https://codeload.github.com/turtl/server/tar.gz/0e59ee0a47fc5937600999d14ceb1aca6392aec8
|
||||||
|
SOURCE_SUM=be1482756fed2fc80dd8592049c2282727439c883eae732844a6e30856eb55da
|
||||||
|
SOURCE_SUM_PRG=sha256sum
|
||||||
|
SOURCE_FORMAT=tar.gz
|
||||||
|
SOURCE_IN_SUBDIR=true
|
||||||
|
SOURCE_FILENAME=
|
||||||
|
SOURCE_EXTRACT=true
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
#-quicklisp
|
|
||||||
(let ((quicklisp-init (merge-pathnames "quicklisp/setup.lisp" (user-homedir-pathname))))
|
|
||||||
(when (probe-file quicklisp-init)
|
|
||||||
(load quicklisp-init)))
|
|
||||||
71
conf/config.yaml.default
Normal file
71
conf/config.yaml.default
Normal file
|
|
@ -0,0 +1,71 @@
|
||||||
|
---
|
||||||
|
server:
|
||||||
|
# Per default, turtl will listen on all IP addresses
|
||||||
|
# You can choose the IP it will use with this parameter
|
||||||
|
host: '127.0.0.1'
|
||||||
|
port: __PORT__
|
||||||
|
|
||||||
|
db:
|
||||||
|
connstr: 'postgres://__DB_USER__:__DB_PWD__@127.0.0.1:5432/__DB_NAME__'
|
||||||
|
pool: 24
|
||||||
|
|
||||||
|
loglevel: 'info'
|
||||||
|
|
||||||
|
app:
|
||||||
|
# ALWAYS false in production. Always.
|
||||||
|
# Set to 'I UNDERSTAND THIS VIOLATES THE PRIVACY OF MY USERS' to enable
|
||||||
|
enable_bookmarker_proxy: false
|
||||||
|
# no trailing slash
|
||||||
|
api_url: 'https://__DOMAIN__'
|
||||||
|
www_url: 'https://__DOMAIN__'
|
||||||
|
login:
|
||||||
|
# Max failed login attemps. Set to -1 to disable
|
||||||
|
max_attemps: 5
|
||||||
|
# User locked for this duration in seconds
|
||||||
|
lock_duration: 60
|
||||||
|
emails:
|
||||||
|
admin: 'admin@__DOMAIN__'
|
||||||
|
info: 'Turtl <info@__DOMAIN__>'
|
||||||
|
invites: 'invites@__DOMAIN__'
|
||||||
|
# TODO: replace this with a long, unique value. seriously. write down a dream
|
||||||
|
# you had, or the short story you came up with during your creative writing
|
||||||
|
# class in your freshmen year of college. have fun with it.
|
||||||
|
secure_hash_salt: "__HASH__"
|
||||||
|
# set to true if you think it's ok to SEND invites if you have not confirmed
|
||||||
|
# your account. great for testing, not so great for production. but what do
|
||||||
|
# i know...
|
||||||
|
allow_unconfirmed_invites: false
|
||||||
|
|
||||||
|
sync:
|
||||||
|
# how many sync records can a client send at a time? it's a good idea to have
|
||||||
|
# a limit here, lest a rogue client flood the server with sync items
|
||||||
|
max_bulk_sync_records: 32
|
||||||
|
|
||||||
|
plugins:
|
||||||
|
plugin_location: '__FINALPATH__/plugins'
|
||||||
|
# each key here corresponds to a folder name in the plugins folder, so `email`
|
||||||
|
# below would be a plugin at /var/www/turtl/server/plugins/email (see the
|
||||||
|
# example-plugins/ folder for an email plugin you can use)
|
||||||
|
#email:
|
||||||
|
# enabled: false
|
||||||
|
# endpoint: 'smtps://user:password@smtp.gmail.com/?pool=true'
|
||||||
|
# defaults: {}
|
||||||
|
|
||||||
|
uploads:
|
||||||
|
# if set to a path, files will be uploaded to the local filesystem instead of
|
||||||
|
# S3. otherwise, set to false
|
||||||
|
local: '__DATADIR__'
|
||||||
|
# if true, downloading local files will be proxied through the turtl server.
|
||||||
|
# this avoids needing to set up any CORS config in your favorite webserver,
|
||||||
|
# but may slightly affect performance on high-demand servers.
|
||||||
|
local_proxy: true
|
||||||
|
# if local_proxy is false, this is should be the url path the uploaded files
|
||||||
|
# are publicly available on
|
||||||
|
url: 'http://api.turtl.dev/uploads'
|
||||||
|
|
||||||
|
s3:
|
||||||
|
token: ''
|
||||||
|
secret: ''
|
||||||
|
bucket: ''
|
||||||
|
endpoint: 'https://s3.amazonaws.com'
|
||||||
|
pathstyle: false
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
/var/log/turtl/turtl.log
|
|
||||||
{
|
|
||||||
rotate 7
|
|
||||||
daily
|
|
||||||
missingok
|
|
||||||
notifempty
|
|
||||||
delaycompress
|
|
||||||
compress
|
|
||||||
postrotate
|
|
||||||
service turtl restart
|
|
||||||
endscript
|
|
||||||
}
|
|
||||||
|
|
@ -1,6 +1,10 @@
|
||||||
location __PATH__ {
|
location / {
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_pass http://127.0.0.1:__PORT____PATH__;
|
proxy_pass http://127.0.0.1:__PORT__;
|
||||||
#--PRIVATE--# Include SSOWAT user panel.
|
proxy_redirect off;
|
||||||
include conf.d/yunohost_panel.conf.inc;
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Host $server_name;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
1757
conf/quicklisp.lisp
1757
conf/quicklisp.lisp
File diff suppressed because it is too large
Load diff
|
|
@ -1,18 +0,0 @@
|
||||||
-----BEGIN PGP SIGNATURE-----
|
|
||||||
Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
|
|
||||||
Comment: GPGTools - https://gpgtools.org
|
|
||||||
|
|
||||||
iQIcBAABCgAGBQJUyVD2AAoJEDB5ZasCi1/3EYAQAIPm+dXrTCRgHA6aFZTc8VeB
|
|
||||||
DoBFsQPlFsLeKjixy3wSalPhI751ItWyy3DOx1tRYpFN0aYGSRbiMuVUF9DVMsSB
|
|
||||||
ROeNCg+f6lvtHuSokHKiZ95y8GarBqs4qguHi1Ir+n+inno4ZfE+8JvrxxQ9Lo4Z
|
|
||||||
KGgRoyJceaVcku3lmQK131i2eOf8RZaHmXv24tHprXpnle0d74etXO0TAdmpk5R2
|
|
||||||
OaeduaitR7o3cGT0JCS39rC5qH/H19jz9XkTjuLOGNqiKcX7XePTejdSLbT7FphN
|
|
||||||
4G2uTN8Z5HiYy56OpcuLdjHlPFiThwmIId6NMO3PHNlVAeL5PMKzw9tZTQlw4C5E
|
|
||||||
XKgL7gqC4L6Ys64/70IIBPo+L8TG74VkEbcWkNr3TCzAdz8x1Sa40YHRoVpRFK8M
|
|
||||||
T+v/qMJ8sgHb9o1OsEniv8eCFyFNPd7AlrRYehWQqRaVCuFG//95jEGNI/ig7vjK
|
|
||||||
v/z6tIyqi2e6zJPsJxAPJ8Y23jkTH4u5dvFct+k1fkZOCIpA/jLUT1RuWqLKTpOF
|
|
||||||
pSlDVmrqjrhM+jVnFEyWOg/mkSmQsY0jfC2sVDpx4XEGq3PdBnKqpPBTL0L8s5sg
|
|
||||||
YmqsGjMVk9IMCtylwuBlP5VGgoB8GmHGdhbeSKNxQJb75voDOiIS/sOP5+ACOxcA
|
|
||||||
Yg8wz616XOOHpLNUki3j
|
|
||||||
=yTd1
|
|
||||||
-----END PGP SIGNATURE-----
|
|
||||||
Binary file not shown.
|
|
@ -1,2 +0,0 @@
|
||||||
if $programname == 'ccl' then /var/log/turtl/turtl.log
|
|
||||||
if $programname == 'ccl' then ~
|
|
||||||
22
conf/systemd.service
Normal file
22
conf/systemd.service
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
[Unit]
|
||||||
|
Description=Turtl Server: Note taking service
|
||||||
|
Documentation=https://turtlapp.com/
|
||||||
|
After=network.target postgresql.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=__APP__
|
||||||
|
Group=__APP__
|
||||||
|
WorkingDirectory=__FINALPATH__/
|
||||||
|
Environment="PATH=__PATH__"
|
||||||
|
ExecStart=__YNH_NODE__ __FINALPATH__/server.js
|
||||||
|
StandardOutput=syslog
|
||||||
|
StandardError=syslog
|
||||||
|
SyslogIdentifier=__APP__
|
||||||
|
Restart=always
|
||||||
|
RestartSec=10
|
||||||
|
StartLimitInterval=900
|
||||||
|
StartLimitBurst=3
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
Package: libuv1-dev
|
|
||||||
Pin: release a=jessie-backports
|
|
||||||
Pin-Priority: 900
|
|
||||||
|
|
||||||
Package: rethinkdb
|
|
||||||
Pin: origin download.rethinkdb.com
|
|
||||||
Pin-Priority: 900
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
deb http://http.debian.net/debian jessie-backports main
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
[Unit]
|
|
||||||
Description=Note taking service
|
|
||||||
Documentation=http://turtl.it
|
|
||||||
Requires=network.target
|
|
||||||
Requires=rethinkdb.service
|
|
||||||
After=network.target
|
|
||||||
After=rethinkdb.service
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=simple
|
|
||||||
User=www-data
|
|
||||||
WorkingDirectory=/var/www/turtl/api/
|
|
||||||
ExecStart=/usr/bin/ccl -Q -b --load start.lisp
|
|
||||||
Restart=on-failure
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
0
doc/.gitkeep
Executable file
0
doc/.gitkeep
Executable file
20
doc/DESCRIPTION.md
Executable file
20
doc/DESCRIPTION.md
Executable file
|
|
@ -0,0 +1,20 @@
|
||||||
|
Turtl is a free online service that allows you to create, synchronize and find your notes, in an encrypted manner.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Different note types: text, bookmark, password, image, and file/document
|
||||||
|
- Client-side cryptography to keep all of your data safe
|
||||||
|
- Securely share with anyone without compromising the security of your data
|
||||||
|
- Sharing allows different permissions ranging from read-only to full ownership of shared content
|
||||||
|
- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date
|
||||||
|
- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data.
|
||||||
|
- Browser extension makes bookmarking easy on desktop
|
||||||
|
- Share to Turtl on Android for easy bookmarking and file uploads
|
||||||
|
- Write notes in Markdown, an easy and natural way to format text
|
||||||
|
- TeX math expressions in notes for math people (surround them by $$ to use)
|
||||||
|
- Multiple translations (German, Spanish, French, and more)
|
||||||
|
- RTL text support for our Farsi/Hebrew/etc-speaking friends
|
||||||
|
- Export/import your entire profile for backup purposes or to move between servers
|
||||||
|
- Semi-offline mode (you only need to be connected to log in)
|
||||||
|
- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts)
|
||||||
|
- An open-source server allows you to host your own Turtl data
|
||||||
0
doc/DISCLAIMER.md
Executable file
0
doc/DISCLAIMER.md
Executable file
0
doc/screenshots/.gitkeep
Executable file
0
doc/screenshots/.gitkeep
Executable file
BIN
doc/screenshots/screenshot.png
Normal file
BIN
doc/screenshots/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
|
|
@ -2,12 +2,18 @@
|
||||||
"name": "Turtl",
|
"name": "Turtl",
|
||||||
"id": "turtl",
|
"id": "turtl",
|
||||||
"packaging_format": 1,
|
"packaging_format": 1,
|
||||||
"version": "0.01",
|
|
||||||
"description": {
|
"description": {
|
||||||
"en": "Share notes, bookmarks, and documents for sensitive projects",
|
"en": "Share notes, bookmarks, and documents for sensitive projects",
|
||||||
"fr": "Partagez des notes, des marque-pages et autre documents pour des projets sensibles"
|
"fr": "Partagez des notes, des marque-pages et autre documents pour des projets sensibles"
|
||||||
},
|
},
|
||||||
"url": "https://turtlapp.com/",
|
"version": "1.0~ynh1",
|
||||||
|
"url": "https://turtlapp.com",
|
||||||
|
"upstream": {
|
||||||
|
"license": "MIT",
|
||||||
|
"website": "https://turtlapp.com",
|
||||||
|
"admindoc": "https://turtlapp.com/docs/",
|
||||||
|
"code": "https://github.com/turtl/server"
|
||||||
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"maintainer": {
|
"maintainer": {
|
||||||
"name": "Luc Didry",
|
"name": "Luc Didry",
|
||||||
|
|
@ -15,41 +21,22 @@
|
||||||
"url": "https://framasoft.org"
|
"url": "https://framasoft.org"
|
||||||
},
|
},
|
||||||
"requirements": {
|
"requirements": {
|
||||||
"yunohost": ">> 2.6.4"
|
"yunohost": ">= 4.3.0"
|
||||||
},
|
},
|
||||||
"multi_instance": false,
|
"multi_instance": false,
|
||||||
"services": [
|
"services": [
|
||||||
"turtl"
|
"nginx"
|
||||||
],
|
],
|
||||||
"arguments": {
|
"arguments": {
|
||||||
"install" : [
|
"install": [
|
||||||
{
|
{
|
||||||
"name": "domain",
|
"name": "domain",
|
||||||
"type": "domain",
|
"type": "domain"
|
||||||
"ask": {
|
|
||||||
"en": "Choose a domain for your turtl server",
|
|
||||||
"fr": "Choisissez un domaine pour votre serveur turtl"
|
|
||||||
},
|
|
||||||
"example": "domain.org"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "path",
|
|
||||||
"type": "path",
|
|
||||||
"ask": {
|
|
||||||
"en": "Choose a path for Turtl",
|
|
||||||
"fr": "Choisissez un chemin pour Turtl"
|
|
||||||
},
|
|
||||||
"example": "/turtl",
|
|
||||||
"default": "/"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "is_public",
|
"name": "is_public",
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"ask": {
|
"default": true
|
||||||
"en": "Is it a public server? (should we announce it?)",
|
|
||||||
"fr": "Est-ce un serveur public ? (devons-nous l'annoncer ?)"
|
|
||||||
},
|
|
||||||
"default": false
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,850 +1,23 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
#=================================================
|
# COMMON VARIABLES
|
||||||
# TESTING
|
|
||||||
#=================================================
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
ynh_fpm_config () {
|
# dependencies used by the app
|
||||||
finalphpconf="/etc/php5/fpm/pool.d/$app.conf"
|
pkg_dependencies="postgresql postgresql-contrib"
|
||||||
ynh_backup_if_checksum_is_different "$finalphpconf" 1
|
|
||||||
sudo cp ../conf/php-fpm.conf "$finalphpconf"
|
|
||||||
ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf"
|
|
||||||
ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf"
|
|
||||||
ynh_replace_string "__USER__" "$app" "$finalphpconf"
|
|
||||||
sudo chown root: "$finalphpconf"
|
|
||||||
ynh_store_file_checksum "$finalphpconf"
|
|
||||||
|
|
||||||
if [ -e "../conf/php-fpm.ini" ]
|
nodejs_version=12
|
||||||
then
|
version_commit=0e59ee0a47fc5937600999d14ceb1aca6392aec8
|
||||||
finalphpini="/etc/php5/fpm/conf.d/20-$app.ini"
|
|
||||||
ynh_backup_if_checksum_is_different "$finalphpini" 1
|
|
||||||
sudo cp ../conf/php-fpm.ini "$finalphpini"
|
|
||||||
sudo chown root: "$finalphpini"
|
|
||||||
ynh_store_file_checksum "$finalphpini"
|
|
||||||
fi
|
|
||||||
|
|
||||||
sudo systemctl reload php5-fpm
|
|
||||||
}
|
|
||||||
|
|
||||||
ynh_remove_fpm_config () {
|
|
||||||
ynh_secure_remove "/etc/php5/fpm/pool.d/$app.conf"
|
|
||||||
ynh_secure_remove "/etc/php5/fpm/conf.d/20-$app.ini"
|
|
||||||
sudo systemctl reload php5-fpm
|
|
||||||
}
|
|
||||||
|
|
||||||
ynh_nginx_config () {
|
|
||||||
finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf"
|
|
||||||
ynh_backup_if_checksum_is_different "$finalnginxconf" 1
|
|
||||||
sudo cp ../conf/nginx.conf "$finalnginxconf"
|
|
||||||
|
|
||||||
# To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
|
|
||||||
# Substitute in a nginx config file only if the variable is not empty
|
|
||||||
if test -n "${path_url:-}"; then
|
|
||||||
ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf"
|
|
||||||
fi
|
|
||||||
if test -n "${domain:-}"; then
|
|
||||||
ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf"
|
|
||||||
fi
|
|
||||||
if test -n "${port:-}"; then
|
|
||||||
ynh_replace_string "__PORT__" "$port" "$finalnginxconf"
|
|
||||||
fi
|
|
||||||
if test -n "${app:-}"; then
|
|
||||||
ynh_replace_string "__NAME__" "$app" "$finalnginxconf"
|
|
||||||
fi
|
|
||||||
if test -n "${final_path:-}"; then
|
|
||||||
ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf"
|
|
||||||
fi
|
|
||||||
ynh_store_file_checksum "$finalnginxconf"
|
|
||||||
|
|
||||||
sudo systemctl reload nginx
|
|
||||||
}
|
|
||||||
|
|
||||||
ynh_remove_nginx_config () {
|
|
||||||
ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf"
|
|
||||||
sudo systemctl reload nginx
|
|
||||||
}
|
|
||||||
|
|
||||||
ynh_systemd_config () {
|
|
||||||
finalsystemdconf="/etc/systemd/system/$app.service"
|
|
||||||
ynh_backup_if_checksum_is_different "$finalsystemdconf" 1
|
|
||||||
sudo cp ../conf/systemd.service "$finalsystemdconf"
|
|
||||||
|
|
||||||
# To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
|
|
||||||
# Substitute in a nginx config file only if the variable is not empty
|
|
||||||
if test -n "${final_path:-}"; then
|
|
||||||
ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf"
|
|
||||||
fi
|
|
||||||
if test -n "${app:-}"; then
|
|
||||||
ynh_replace_string "__APP__" "$app" "$finalsystemdconf"
|
|
||||||
fi
|
|
||||||
ynh_store_file_checksum "$finalsystemdconf"
|
|
||||||
|
|
||||||
sudo chown root: "$finalsystemdconf"
|
|
||||||
sudo systemctl enable $app
|
|
||||||
sudo systemctl daemon-reload
|
|
||||||
}
|
|
||||||
|
|
||||||
ynh_remove_systemd_config () {
|
|
||||||
finalsystemdconf="/etc/systemd/system/$app.service"
|
|
||||||
if [ -e "$finalsystemdconf" ]; then
|
|
||||||
sudo systemctl stop $app
|
|
||||||
sudo systemctl disable $app
|
|
||||||
ynh_secure_remove "$finalsystemdconf"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
# PERSONAL HELPERS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# CHECKING
|
# EXPERIMENTAL HELPERS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine.
|
|
||||||
if sudo yunohost app --help | grep --quiet url-available
|
|
||||||
then
|
|
||||||
# Check availability of a web path
|
|
||||||
ynh_webpath_available $domain $path_url
|
|
||||||
# Register/book a web path for an app
|
|
||||||
ynh_webpath_register $app $domain $path_url
|
|
||||||
else
|
|
||||||
# Use the legacy command
|
|
||||||
sudo yunohost app checkurl $domain$path_url -a $app
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà utilisé.
|
|
||||||
final_path=/var/www/$app
|
|
||||||
test ! -e "$final_path" || ynh_die "This path already contains a folder"
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# DISPLAYING
|
# FUTURE OFFICIAL HELPERS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
NO_PRINT () { # Supprime l'affichage dans stdout pour la commande en argument.
|
|
||||||
set +x
|
|
||||||
$@
|
|
||||||
set -x
|
|
||||||
}
|
|
||||||
|
|
||||||
WARNING () { # Écrit sur le canal d'erreur pour passer en warning.
|
|
||||||
$@ >&2
|
|
||||||
}
|
|
||||||
|
|
||||||
SUPPRESS_WARNING () { # Force l'écriture sur la sortie standard
|
|
||||||
$@ 2>&1
|
|
||||||
}
|
|
||||||
|
|
||||||
QUIET () { # Redirige la sortie standard dans /dev/null
|
|
||||||
$@ > /dev/null
|
|
||||||
}
|
|
||||||
|
|
||||||
ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null
|
|
||||||
$@ > /dev/null 2>&1
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# BACKUP
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
BACKUP_FAIL_UPGRADE () {
|
|
||||||
WARNING echo "Upgrade failed."
|
|
||||||
app_bck=${app//_/-} # Replace all '_' by '-'
|
|
||||||
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number; then # Vérifie l'existence de l'archive avant de supprimer l'application et de restaurer
|
|
||||||
sudo yunohost app remove $app # Supprime l'application avant de la restaurer.
|
|
||||||
sudo yunohost backup restore --ignore-hooks $app_bck-pre-upgrade$backup_number --apps $app --force # Restore the backup if upgrade failed
|
|
||||||
ynh_die "The app was restored to the way it was before the failed upgrade."
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
BACKUP_BEFORE_UPGRADE () { # Backup the current version of the app, restore it if the upgrade fails
|
|
||||||
backup_number=1
|
|
||||||
old_backup_number=2
|
|
||||||
app_bck=${app//_/-} # Replace all '_' by '-'
|
|
||||||
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1; then # Vérifie l'existence d'une archive déjà numéroté à 1.
|
|
||||||
backup_number=2 # Et passe le numéro de l'archive à 2
|
|
||||||
old_backup_number=1
|
|
||||||
fi
|
|
||||||
|
|
||||||
sudo yunohost backup create --ignore-hooks --apps $app --name $app_bck-pre-upgrade$backup_number # Créer un backup différent de celui existant.
|
|
||||||
if [ "$?" -eq 0 ]; then # Si le backup est un succès, supprime l'archive précédente.
|
|
||||||
if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number; then # Vérifie l'existence de l'ancienne archive avant de la supprimer, pour éviter une erreur.
|
|
||||||
QUIET sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number
|
|
||||||
fi
|
|
||||||
else # Si le backup a échoué
|
|
||||||
ynh_die "Backup failed, the upgrade process was aborted."
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
HUMAN_SIZE () { # Transforme une taille en Ko en une taille lisible pour un humain
|
|
||||||
human=$(numfmt --to=iec --from-unit=1K $1)
|
|
||||||
echo $human
|
|
||||||
}
|
|
||||||
|
|
||||||
CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant
|
|
||||||
file_to_analyse=$1
|
|
||||||
backup_size=$(sudo du --summarize "$file_to_analyse" | cut -f1)
|
|
||||||
free_space=$(sudo df --output=avail "/home/yunohost.backup" | sed 1d)
|
|
||||||
|
|
||||||
if [ $free_space -le $backup_size ]
|
|
||||||
then
|
|
||||||
WARNING echo "Espace insuffisant pour sauvegarder $file_to_analyse."
|
|
||||||
WARNING echo "Espace disponible: $(HUMAN_SIZE $free_space)"
|
|
||||||
ynh_die "Espace nécessaire: $(HUMAN_SIZE $backup_size)"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Ce helper est temporaire et sert de remplacement à la véritable fonction ynh_restore_file. Le temps qu'elle arrive...
|
|
||||||
ynh_restore_file () {
|
|
||||||
if [ -f "$1" ]; then
|
|
||||||
ynh_die "There is already a file at this path: $1"
|
|
||||||
fi
|
|
||||||
sudo cp -a "${YNH_APP_BACKUP_DIR}$1" "$1"
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# PACKAGE CHECK BYPASSING...
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
IS_PACKAGE_CHECK () { # Détermine une exécution en conteneur (Non testé)
|
|
||||||
return $(uname -n | grep -c 'pchecker_lxc')
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# NODEJS
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
sudo_path () {
|
|
||||||
sudo env "PATH=$PATH" $@
|
|
||||||
}
|
|
||||||
|
|
||||||
# INFOS
|
|
||||||
# n (Node version management) utilise la variable PATH pour stocker le path de la version de node à utiliser.
|
|
||||||
# C'est ainsi qu'il change de version
|
|
||||||
# En attendant une généralisation de root, il est possible d'utiliser sudo avec le helper temporaire sudo_path
|
|
||||||
# Il permet d'utiliser sudo en gardant le $PATH modifié
|
|
||||||
# ynh_install_nodejs installe la version de nodejs demandée en argument, avec n
|
|
||||||
# ynh_use_nodejs active une version de nodejs dans le script courant
|
|
||||||
# 3 variables sont mises à disposition, et 2 sont stockées dans la config de l'app
|
|
||||||
# - nodejs_path: Le chemin absolu de cette version de node
|
|
||||||
# Utilisé pour des appels directs à node.
|
|
||||||
# - nodejs_version: Simplement le numéro de version de nodejs pour cette application
|
|
||||||
# - nodejs_use_version: Un alias pour charger une version de node dans le shell courant.
|
|
||||||
# Utilisé pour démarrer un service ou un script qui utilise node ou npm
|
|
||||||
# Dans ce cas, c'est $PATH qui contient le chemin de la version de node. Il doit être propagé sur les autres shell si nécessaire.
|
|
||||||
|
|
||||||
n_install_dir="/opt/node_n"
|
|
||||||
ynh_use_nodejs () {
|
|
||||||
nodejs_version=$(ynh_app_setting_get $app nodejs_version)
|
|
||||||
|
|
||||||
load_n_path="[[ :$PATH: == *\":$n_install_dir/bin:\"* ]] || PATH+=\":$n_install_dir/bin\""
|
|
||||||
|
|
||||||
nodejs_use_version="n $nodejs_version"
|
|
||||||
|
|
||||||
# "Load" a version of node
|
|
||||||
eval $load_n_path; $nodejs_use_version
|
|
||||||
eval $load_n_path; sudo env "PATH=$PATH" $nodejs_use_version
|
|
||||||
|
|
||||||
# Get the absolute path of this version of node
|
|
||||||
nodejs_path="$(n bin $nodejs_version)"
|
|
||||||
|
|
||||||
# Make an alias for node use
|
|
||||||
ynh_node_exec="eval $load_n_path; n use $nodejs_version"
|
|
||||||
sudo_ynh_node_exec="eval $load_n_path; sudo env \"PATH=$PATH\" n use $nodejs_version"
|
|
||||||
}
|
|
||||||
|
|
||||||
ynh_install_nodejs () {
|
|
||||||
# Use n, https://github.com/tj/n to manage the nodejs versions
|
|
||||||
local nodejs_version="$1"
|
|
||||||
local n_install_script="https://git.io/n-install"
|
|
||||||
|
|
||||||
# Create $n_install_dir
|
|
||||||
sudo mkdir -p "$n_install_dir"
|
|
||||||
|
|
||||||
# Load n path in PATH
|
|
||||||
PATH+=":$n_install_dir/bin"
|
|
||||||
|
|
||||||
# If n is not previously setup, install it
|
|
||||||
n --version > /dev/null 2>&1 || \
|
|
||||||
( echo "Installation of N - Node.js version management" >&2; \
|
|
||||||
curl -sL $n_install_script | sudo N_PREFIX="$n_install_dir" bash -s -- -y $nodejs_version )
|
|
||||||
|
|
||||||
# Install the requested version of nodejs (except for the first installation of n, which installed the requested version of node.)
|
|
||||||
sudo env "PATH=$PATH" n $nodejs_version
|
|
||||||
|
|
||||||
# Use the real installed version. Sometimes slightly different
|
|
||||||
nodejs_version=$(node --version | cut -c2-)
|
|
||||||
|
|
||||||
# Store the ID of this app and the version of node requested for it
|
|
||||||
echo "$YNH_APP_ID:$nodejs_version" | sudo tee --append "$n_install_dir/ynh_app_version"
|
|
||||||
|
|
||||||
# Store nodejs_version into the config of this app
|
|
||||||
ynh_app_setting_set $app nodejs_version $nodejs_version
|
|
||||||
|
|
||||||
ynh_use_nodejs
|
|
||||||
}
|
|
||||||
|
|
||||||
ynh_remove_nodejs () {
|
|
||||||
ynh_use_nodejs
|
|
||||||
|
|
||||||
# Remove the line for this app
|
|
||||||
sudo sed --in-place "/$YNH_APP_ID:$nodejs_version/d" "$n_install_dir/ynh_app_version"
|
|
||||||
|
|
||||||
# If none another app uses this version of nodejs, remove it.
|
|
||||||
if ! grep --quiet "$nodejs_version" "$n_install_dir/ynh_app_version"
|
|
||||||
then
|
|
||||||
n rm $nodejs_version
|
|
||||||
fi
|
|
||||||
|
|
||||||
# If none another app uses n, remove n
|
|
||||||
if [ ! -s "$n_install_dir/ynh_app_version" ]
|
|
||||||
then
|
|
||||||
ynh_secure_remove "$n_install_dir"
|
|
||||||
sudo sed --in-place "/N_PREFIX/d" /root/.bashrc
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
#=================================================
|
|
||||||
# FUTUR YNH HELPERS
|
|
||||||
#=================================================
|
|
||||||
# Importer ce fichier de fonction avant celui des helpers officiel
|
|
||||||
# Ainsi, les officiels prendront le pas sur ceux-ci le cas échéant
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# Normalize the url path syntax
|
|
||||||
# Handle the slash at the beginning of path and its absence at ending
|
|
||||||
# Return a normalized url path
|
|
||||||
#
|
|
||||||
# example: url_path=$(ynh_normalize_url_path $url_path)
|
|
||||||
# ynh_normalize_url_path example -> /example
|
|
||||||
# ynh_normalize_url_path /example -> /example
|
|
||||||
# ynh_normalize_url_path /example/ -> /example
|
|
||||||
# ynh_normalize_url_path / -> /
|
|
||||||
#
|
|
||||||
# usage: ynh_normalize_url_path path_to_normalize
|
|
||||||
# | arg: url_path_to_normalize - URL path to normalize before using it
|
|
||||||
ynh_normalize_url_path () {
|
|
||||||
path_url=$1
|
|
||||||
test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing."
|
|
||||||
if [ "${path_url:0:1}" != "/" ]; then # If the first character is not a /
|
|
||||||
path_url="/$path_url" # Add / at begin of path variable
|
|
||||||
fi
|
|
||||||
if [ "${path_url:${#path_url}-1}" == "/" ] && [ ${#path_url} -gt 1 ]; then # If the last character is a / and that not the only character.
|
|
||||||
path_url="${path_url:0:${#path_url}-1}" # Delete the last character
|
|
||||||
fi
|
|
||||||
echo $path_url
|
|
||||||
}
|
|
||||||
|
|
||||||
# Check if a mysql user exists
|
|
||||||
#
|
|
||||||
# usage: ynh_mysql_user_exists user
|
|
||||||
# | arg: user - the user for which to check existence
|
|
||||||
function ynh_mysql_user_exists()
|
|
||||||
{
|
|
||||||
local user=$1
|
|
||||||
if [[ -z $(ynh_mysql_execute_as_root "SELECT User from mysql.user WHERE User = '$user';") ]]
|
|
||||||
then
|
|
||||||
return 1
|
|
||||||
else
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Create a database, an user and its password. Then store the password in the app's config
|
|
||||||
#
|
|
||||||
# After executing this helper, the password of the created database will be available in $db_pwd
|
|
||||||
# It will also be stored as "mysqlpwd" into the app settings.
|
|
||||||
#
|
|
||||||
# usage: ynh_mysql_setup_db user name [pwd]
|
|
||||||
# | arg: user - Owner of the database
|
|
||||||
# | arg: name - Name of the database
|
|
||||||
# | arg: pwd - Password of the database. If not given, a password will be generated
|
|
||||||
ynh_mysql_setup_db () {
|
|
||||||
local db_user="$1"
|
|
||||||
local db_name="$2"
|
|
||||||
local new_db_pwd=$(ynh_string_random) # Generate a random password
|
|
||||||
db_pwd="${3:-$new_db_pwd}"
|
|
||||||
ynh_mysql_create_db "$db_name" "$db_user" "$db_pwd" # Create the database
|
|
||||||
ynh_app_setting_set $app mysqlpwd $db_pwd # Store the password in the app's config
|
|
||||||
}
|
|
||||||
|
|
||||||
# Remove a database if it exists, and the associated user
|
|
||||||
#
|
|
||||||
# usage: ynh_mysql_remove_db user name
|
|
||||||
# | arg: user - Owner of the database
|
|
||||||
# | arg: name - Name of the database
|
|
||||||
ynh_mysql_remove_db () {
|
|
||||||
local db_user="$1"
|
|
||||||
local db_name="$2"
|
|
||||||
local mysql_root_password=$(sudo cat $MYSQL_ROOT_PWD_FILE)
|
|
||||||
if mysqlshow -u root -p$mysql_root_password | grep -q "^| $db_name"; then # Check if the database exists
|
|
||||||
echo "Removing database $db_name" >&2
|
|
||||||
ynh_mysql_drop_db $db_name # Remove the database
|
|
||||||
else
|
|
||||||
echo "Database $db_name not found" >&2
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Remove mysql user if it exists
|
|
||||||
if $(ynh_mysql_user_exists $db_user); then
|
|
||||||
ynh_mysql_drop_user $db_user
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Correct the name given in argument for mariadb
|
|
||||||
#
|
|
||||||
# Avoid invalid name for your database
|
|
||||||
#
|
|
||||||
# Exemple: dbname=$(ynh_make_valid_dbid $app)
|
|
||||||
#
|
|
||||||
# usage: ynh_make_valid_dbid name
|
|
||||||
# | arg: name - name to correct
|
|
||||||
# | ret: the corrected name
|
|
||||||
ynh_sanitize_dbid () {
|
|
||||||
dbid=${1//[-.]/_} # We should avoid having - and . in the name of databases. They are replaced by _
|
|
||||||
echo $dbid
|
|
||||||
}
|
|
||||||
|
|
||||||
# Manage a fail of the script
|
|
||||||
#
|
|
||||||
# Print a warning to inform that the script was failed
|
|
||||||
# Execute the ynh_clean_setup function if used in the app script
|
|
||||||
#
|
|
||||||
# usage of ynh_clean_setup function
|
|
||||||
# This function provide a way to clean some residual of installation that not managed by remove script.
|
|
||||||
# To use it, simply add in your script:
|
|
||||||
# ynh_clean_setup () {
|
|
||||||
# instructions...
|
|
||||||
# }
|
|
||||||
# This function is optionnal.
|
|
||||||
#
|
|
||||||
# Usage: ynh_exit_properly is used only by the helper ynh_abort_if_errors.
|
|
||||||
# You must not use it directly.
|
|
||||||
ynh_exit_properly () {
|
|
||||||
exit_code=$?
|
|
||||||
if [ "$exit_code" -eq 0 ]; then
|
|
||||||
exit 0 # Exit without error if the script ended correctly
|
|
||||||
fi
|
|
||||||
|
|
||||||
trap '' EXIT # Ignore new exit signals
|
|
||||||
set +eu # Do not exit anymore if a command fail or if a variable is empty
|
|
||||||
|
|
||||||
echo -e "!!\n $app's script has encountered an error. Its execution was cancelled.\n!!" >&2
|
|
||||||
|
|
||||||
if type -t ynh_clean_setup > /dev/null; then # Check if the function exist in the app script.
|
|
||||||
ynh_clean_setup # Call the function to do specific cleaning for the app.
|
|
||||||
fi
|
|
||||||
|
|
||||||
ynh_die # Exit with error status
|
|
||||||
}
|
|
||||||
|
|
||||||
# Exit if an error occurs during the execution of the script.
|
|
||||||
#
|
|
||||||
# Stop immediatly the execution if an error occured or if a empty variable is used.
|
|
||||||
# The execution of the script is derivate to ynh_exit_properly function before exit.
|
|
||||||
#
|
|
||||||
# Usage: ynh_abort_if_errors
|
|
||||||
ynh_abort_if_errors () {
|
|
||||||
set -eu # Exit if a command fail, and if a variable is used unset.
|
|
||||||
trap ynh_exit_properly EXIT # Capturing exit signals on shell script
|
|
||||||
}
|
|
||||||
|
|
||||||
# Define and install dependencies with a equivs control file
|
|
||||||
# This helper can/should only be called once per app
|
|
||||||
#
|
|
||||||
# usage: ynh_install_app_dependencies dep [dep [...]]
|
|
||||||
# | arg: dep - the package name to install in dependence
|
|
||||||
ynh_install_app_dependencies () {
|
|
||||||
dependencies=$@
|
|
||||||
manifest_path="../manifest.json"
|
|
||||||
if [ ! -e "$manifest_path" ]; then
|
|
||||||
manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place
|
|
||||||
fi
|
|
||||||
version=$(sudo grep '\"version\": ' "$manifest_path" | cut -d '"' -f 4) # Retrieve the version number in the manifest file.
|
|
||||||
dep_app=${app//_/-} # Replace all '_' by '-'
|
|
||||||
|
|
||||||
if ynh_package_is_installed "${dep_app}-ynh-deps"; then
|
|
||||||
echo "A package named ${dep_app}-ynh-deps is already installed" >&2
|
|
||||||
else
|
|
||||||
cat > ./${dep_app}-ynh-deps.control << EOF # Make a control file for equivs-build
|
|
||||||
Section: misc
|
|
||||||
Priority: optional
|
|
||||||
Package: ${dep_app}-ynh-deps
|
|
||||||
Version: ${version}
|
|
||||||
Depends: ${dependencies// /, }
|
|
||||||
Architecture: all
|
|
||||||
Description: Fake package for ${app} (YunoHost app) dependencies
|
|
||||||
This meta-package is only responsible of installing its dependencies.
|
|
||||||
EOF
|
|
||||||
ynh_package_install_from_equivs ./${dep_app}-ynh-deps.control \
|
|
||||||
|| ynh_die "Unable to install dependencies" # Install the fake package and its dependencies
|
|
||||||
ynh_app_setting_set $app apt_dependencies $dependencies
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Remove fake package and its dependencies
|
|
||||||
#
|
|
||||||
# Dependencies will removed only if no other package need them.
|
|
||||||
#
|
|
||||||
# usage: ynh_remove_app_dependencies
|
|
||||||
ynh_remove_app_dependencies () {
|
|
||||||
dep_app=${app//_/-} # Replace all '_' by '-'
|
|
||||||
ynh_package_autoremove ${dep_app}-ynh-deps # Remove the fake package and its dependencies if they not still used.
|
|
||||||
}
|
|
||||||
|
|
||||||
# Use logrotate to manage the logfile
|
|
||||||
#
|
|
||||||
# usage: ynh_use_logrotate [logfile]
|
|
||||||
# | arg: logfile - absolute path of logfile
|
|
||||||
#
|
|
||||||
# If no argument provided, a standard directory will be use. /var/log/${app}
|
|
||||||
# You can provide a path with the directory only or with the logfile.
|
|
||||||
# /parentdir/logdir/
|
|
||||||
# /parentdir/logdir/logfile.log
|
|
||||||
#
|
|
||||||
# It's possible to use this helper several times, each config will added to same logrotate config file.
|
|
||||||
ynh_use_logrotate () {
|
|
||||||
if [ "$#" -gt 0 ]; then
|
|
||||||
if [ "$(echo ${1##*.})" == "log" ]; then # Keep only the extension to check if it's a logfile
|
|
||||||
logfile=$1 # In this case, focus logrotate on the logfile
|
|
||||||
else
|
|
||||||
logfile=$1/.log # Else, uses the directory and all logfile into it.
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
logfile="/var/log/${app}/*.log" # Without argument, use a defaut directory in /var/log
|
|
||||||
fi
|
|
||||||
cat > ./${app}-logrotate << EOF # Build a config file for logrotate
|
|
||||||
$logfile {
|
|
||||||
# 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
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
sudo mkdir -p $(dirname "$logfile") # Create the log directory, if not exist
|
|
||||||
cat ${app}-logrotate | sudo tee -a /etc/logrotate.d/$app > /dev/null # Append this config to the others for this app. If a config file already exist
|
|
||||||
}
|
|
||||||
|
|
||||||
# Remove the app's logrotate config.
|
|
||||||
#
|
|
||||||
# usage: ynh_remove_logrotate
|
|
||||||
ynh_remove_logrotate () {
|
|
||||||
if [ -e "/etc/logrotate.d/$app" ]; then
|
|
||||||
sudo rm "/etc/logrotate.d/$app"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Find a free port and return it
|
|
||||||
#
|
|
||||||
# example: port=$(ynh_find_port 8080)
|
|
||||||
#
|
|
||||||
# usage: ynh_find_port begin_port
|
|
||||||
# | arg: begin_port - port to start to search
|
|
||||||
ynh_find_port () {
|
|
||||||
port=$1
|
|
||||||
test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port."
|
|
||||||
while netcat -z 127.0.0.1 $port # Check if the port is free
|
|
||||||
do
|
|
||||||
port=$((port+1)) # Else, pass to next port
|
|
||||||
done
|
|
||||||
echo $port
|
|
||||||
}
|
|
||||||
|
|
||||||
# Create a system user
|
|
||||||
#
|
|
||||||
# usage: ynh_system_user_create user_name [home_dir]
|
|
||||||
# | arg: user_name - Name of the system user that will be create
|
|
||||||
# | arg: home_dir - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home
|
|
||||||
ynh_system_user_create () {
|
|
||||||
if ! ynh_system_user_exists "$1" # Check if the user exists on the system
|
|
||||||
then # If the user doesn't exist
|
|
||||||
if [ $# -ge 2 ]; then # If a home dir is mentioned
|
|
||||||
user_home_dir="-d $2"
|
|
||||||
else
|
|
||||||
user_home_dir="--no-create-home"
|
|
||||||
fi
|
|
||||||
sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Delete a system user
|
|
||||||
#
|
|
||||||
# usage: ynh_system_user_delete user_name
|
|
||||||
# | arg: user_name - Name of the system user that will be create
|
|
||||||
ynh_system_user_delete () {
|
|
||||||
if ynh_system_user_exists "$1" # Check if the user exists on the system
|
|
||||||
then
|
|
||||||
echo "Remove the user $1" >&2
|
|
||||||
sudo userdel $1
|
|
||||||
else
|
|
||||||
echo "The user $1 was not found" >&2
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Curl abstraction to help with POST requests to local pages (such as installation forms)
|
|
||||||
#
|
|
||||||
# $domain and $path_url should be defined externally (and correspond to the domain.tld and the /path (of the app?))
|
|
||||||
#
|
|
||||||
# example: ynh_local_curl "/install.php?installButton" "foo=$var1" "bar=$var2"
|
|
||||||
#
|
|
||||||
# usage: ynh_local_curl "page_uri" "key1=value1" "key2=value2" ...
|
|
||||||
# | arg: page_uri - Path (relative to $path_url) of the page where POST data will be sent
|
|
||||||
# | arg: key1=value1 - (Optionnal) POST key and corresponding value
|
|
||||||
# | arg: key2=value2 - (Optionnal) Another POST key and corresponding value
|
|
||||||
# | arg: ... - (Optionnal) More POST keys and values
|
|
||||||
ynh_local_curl () {
|
|
||||||
# Define url of page to curl
|
|
||||||
full_page_url=https://localhost$path_url$1
|
|
||||||
|
|
||||||
# Concatenate all other arguments with '&' to prepare POST data
|
|
||||||
POST_data=""
|
|
||||||
for arg in "${@:2}"
|
|
||||||
do
|
|
||||||
POST_data="${POST_data}${arg}&"
|
|
||||||
done
|
|
||||||
if [ -n "$POST_data" ]
|
|
||||||
then
|
|
||||||
# Add --data arg and remove the last character, which is an unecessary '&'
|
|
||||||
POST_data="--data \"${POST_data::-1}\""
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Curl the URL
|
|
||||||
curl --silent --show-error -kL -H "Host: $domain" --resolve $domain:443:127.0.0.1 $POST_data "$full_page_url"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Substitute/replace a string by another in a file
|
|
||||||
#
|
|
||||||
# usage: ynh_replace_string match_string replace_string target_file
|
|
||||||
# | arg: match_string - String to be searched and replaced in the file
|
|
||||||
# | arg: replace_string - String that will replace matches
|
|
||||||
# | arg: target_file - File in which the string will be replaced.
|
|
||||||
ynh_replace_string () {
|
|
||||||
delimit=@
|
|
||||||
match_string=${1//${delimit}/"\\${delimit}"} # Escape the delimiter if it's in the string.
|
|
||||||
replace_string=${2//${delimit}/"\\${delimit}"}
|
|
||||||
workfile=$3
|
|
||||||
|
|
||||||
sudo sed --in-place "s${delimit}${match_string}${delimit}${replace_string}${delimit}g" "$workfile"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Remove a file or a directory securely
|
|
||||||
#
|
|
||||||
# usage: ynh_secure_remove path_to_remove
|
|
||||||
# | arg: path_to_remove - File or directory to remove
|
|
||||||
ynh_secure_remove () {
|
|
||||||
path_to_remove=$1
|
|
||||||
forbidden_path=" \
|
|
||||||
/var/www \
|
|
||||||
/home/yunohost.app"
|
|
||||||
|
|
||||||
if [[ "$forbidden_path" =~ "$path_to_remove" \
|
|
||||||
# Match all paths or subpaths in $forbidden_path
|
|
||||||
|| "$path_to_remove" =~ ^/[[:alnum:]]+$ \
|
|
||||||
# Match all first level paths from / (Like /var, /root, etc...)
|
|
||||||
|| "${path_to_remove:${#path_to_remove}-1}" = "/" ]]
|
|
||||||
# Match if the path finishes by /. Because it seems there is an empty variable
|
|
||||||
then
|
|
||||||
echo "Avoid deleting $path_to_remove." >&2
|
|
||||||
else
|
|
||||||
if [ -e "$path_to_remove" ]
|
|
||||||
then
|
|
||||||
sudo rm -R "$path_to_remove"
|
|
||||||
else
|
|
||||||
echo "$path_to_remove wasn't deleted because it doesn't exist." >&2
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Download, check integrity, uncompress and patch the source from app.src
|
|
||||||
#
|
|
||||||
# The file conf/app.src need to contains:
|
|
||||||
#
|
|
||||||
# SOURCE_URL=Address to download the app archive
|
|
||||||
# SOURCE_SUM=Control sum
|
|
||||||
# # (Optional) Programm to check the integrity (sha256sum, md5sum$YNH_EXECUTION_DIR/...)
|
|
||||||
# # default: sha256
|
|
||||||
# SOURCE_SUM_PRG=sha256
|
|
||||||
# # (Optional) Archive format
|
|
||||||
# # default: tar.gz
|
|
||||||
# SOURCE_FORMAT=tar.gz
|
|
||||||
# # (Optional) Put false if source are directly in the archive root
|
|
||||||
# # default: true
|
|
||||||
# SOURCE_IN_SUBDIR=false
|
|
||||||
# # (Optionnal) Name of the local archive (offline setup support)
|
|
||||||
# # default: ${src_id}.${src_format}
|
|
||||||
# SOURCE_FILENAME=example.tar.gz
|
|
||||||
#
|
|
||||||
# Details:
|
|
||||||
# This helper download sources from SOURCE_URL if there is no local source
|
|
||||||
# archive in /opt/yunohost-apps-src/APP_ID/SOURCE_FILENAME
|
|
||||||
#
|
|
||||||
# Next, it check the integrity with "SOURCE_SUM_PRG -c --status" command.
|
|
||||||
#
|
|
||||||
# If it's ok, the source archive will be uncompress in $dest_dir. If the
|
|
||||||
# SOURCE_IN_SUBDIR is true, the first level directory of the archive will be
|
|
||||||
# removed.
|
|
||||||
#
|
|
||||||
# Finally, patches named sources/patches/${src_id}-*.patch and extra files in
|
|
||||||
# sources/extra_files/$src_id will be applyed to dest_dir
|
|
||||||
#
|
|
||||||
#
|
|
||||||
# usage: ynh_setup_source dest_dir [source_id]
|
|
||||||
# | arg: dest_dir - Directory where to setup sources
|
|
||||||
# | arg: source_id - Name of the app, if the package contains more than one app
|
|
||||||
YNH_EXECUTION_DIR="."
|
|
||||||
ynh_setup_source () {
|
|
||||||
local dest_dir=$1
|
|
||||||
local src_id=${2:-app} # If the argument is not given, source_id equal "app"
|
|
||||||
|
|
||||||
# Load value from configuration file (see above for a small doc about this file
|
|
||||||
# format)
|
|
||||||
local src_url=$(grep 'SOURCE_URL=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-)
|
|
||||||
local src_sum=$(grep 'SOURCE_SUM=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-)
|
|
||||||
local src_sumprg=$(grep 'SOURCE_SUM_PRG=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-)
|
|
||||||
local src_format=$(grep 'SOURCE_FORMAT=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-)
|
|
||||||
local src_in_subdir=$(grep 'SOURCE_IN_SUBDIR=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-)
|
|
||||||
local src_filename=$(grep 'SOURCE_FILENAME=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-)
|
|
||||||
|
|
||||||
# Default value
|
|
||||||
src_sumprg=${src_sumprg:-sha256sum}
|
|
||||||
src_in_subdir=${src_in_subdir:-true}
|
|
||||||
src_format=${src_format:-tar.gz}
|
|
||||||
src_format=$(echo "$src_format" | tr '[:upper:]' '[:lower:]')
|
|
||||||
if [ "$src_filename" = "" ] ; then
|
|
||||||
src_filename="${src_id}.${src_format}"
|
|
||||||
fi
|
|
||||||
local local_src="/opt/yunohost-apps-src/${YNH_APP_ID}/${src_filename}"
|
|
||||||
|
|
||||||
if test -e "$local_src"
|
|
||||||
then # Use the local source file if it is present
|
|
||||||
cp $local_src $src_filename
|
|
||||||
else # If not, download the source
|
|
||||||
wget -nv -O $src_filename $src_url
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Check the control sum
|
|
||||||
echo "${src_sum} ${src_filename}" | ${src_sumprg} -c --status \
|
|
||||||
|| ynh_die "Corrupt source"
|
|
||||||
|
|
||||||
# Extract source into the app dir
|
|
||||||
sudo mkdir -p "$dest_dir"
|
|
||||||
if [ "$src_format" = "zip" ]
|
|
||||||
then
|
|
||||||
# Zip format
|
|
||||||
# Using of a temp directory, because unzip doesn't manage --strip-components
|
|
||||||
if $src_in_subdir ; then
|
|
||||||
local tmp_dir=$(mktemp -d)
|
|
||||||
sudo unzip -quo $src_filename -d "$tmp_dir"
|
|
||||||
sudo cp -a $tmp_dir/*/. "$dest_dir"
|
|
||||||
ynh_secure_remove "$tmp_dir"
|
|
||||||
else
|
|
||||||
sudo unzip -quo $src_filename -d "$dest_dir"
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
local strip=""
|
|
||||||
if $src_in_subdir ; then
|
|
||||||
strip="--strip-components 1"
|
|
||||||
fi
|
|
||||||
if [[ "$src_format" =~ ^tar.gz|tar.bz2|tar.xz$ ]] ; then
|
|
||||||
sudo tar -xf $src_filename -C "$dest_dir" $strip
|
|
||||||
else
|
|
||||||
ynh_die "Archive format unrecognized."
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Apply patches
|
|
||||||
if (( $(find $YNH_EXECUTION_DIR/../sources/patches/ -type f -name "${src_id}-*.patch" 2> /dev/null | wc -l) > "0" )); then
|
|
||||||
local old_dir=$(pwd)
|
|
||||||
(cd "$dest_dir" \
|
|
||||||
&& for p in $YNH_EXECUTION_DIR/../sources/patches/${src_id}-*.patch; do \
|
|
||||||
sudo patch -p1 < $p; done) \
|
|
||||||
|| ynh_die "Unable to apply patches"
|
|
||||||
cd $old_dir
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Add supplementary files
|
|
||||||
if test -e "$YNH_EXECUTION_DIR/../sources/extra_files/${src_id}"; then
|
|
||||||
sudo cp -a $YNH_EXECUTION_DIR/../sources/extra_files/$src_id/. "$dest_dir"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Check availability of a web path
|
|
||||||
#
|
|
||||||
# example: ynh_webpath_available some.domain.tld /coffee
|
|
||||||
#
|
|
||||||
# usage: ynh_webpath_available domain path
|
|
||||||
# | arg: domain - the domain/host of the url
|
|
||||||
# | arg: path - the web path to check the availability of
|
|
||||||
ynh_webpath_available () {
|
|
||||||
local domain=$1
|
|
||||||
local path=$2
|
|
||||||
sudo yunohost domain url-available $domain $path
|
|
||||||
}
|
|
||||||
|
|
||||||
# Register/book a web path for an app
|
|
||||||
#
|
|
||||||
# example: ynh_webpath_register wordpress some.domain.tld /coffee
|
|
||||||
#
|
|
||||||
# usage: ynh_webpath_register app domain path
|
|
||||||
# | arg: app - the app for which the domain should be registered
|
|
||||||
# | arg: domain - the domain/host of the web path
|
|
||||||
# | arg: path - the web path to be registered
|
|
||||||
ynh_webpath_register () {
|
|
||||||
local app=$1
|
|
||||||
local domain=$2
|
|
||||||
local path=$3
|
|
||||||
sudo yunohost app register-url $app $domain $path
|
|
||||||
}
|
|
||||||
|
|
||||||
# Calculate and store a file checksum into the app settings
|
|
||||||
#
|
|
||||||
# $app should be defined when calling this helper
|
|
||||||
#
|
|
||||||
# usage: ynh_store_file_checksum file
|
|
||||||
# | arg: file - The file on which the checksum will performed, then stored.
|
|
||||||
ynh_store_file_checksum () {
|
|
||||||
local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_'
|
|
||||||
ynh_app_setting_set $app $checksum_setting_name $(sudo md5sum "$1" | cut -d' ' -f1)
|
|
||||||
}
|
|
||||||
|
|
||||||
# Verify the checksum and backup the file if it's different
|
|
||||||
# This helper is primarily meant to allow to easily backup personalised/manually
|
|
||||||
# modified config files.
|
|
||||||
#
|
|
||||||
# $app should be defined when calling this helper
|
|
||||||
#
|
|
||||||
# usage: ynh_backup_if_checksum_is_different file
|
|
||||||
# | arg: file - The file on which the checksum test will be perfomed.
|
|
||||||
#
|
|
||||||
# | ret: Return the name a the backup file, or nothing
|
|
||||||
ynh_backup_if_checksum_is_different () {
|
|
||||||
local file=$1
|
|
||||||
local checksum_setting_name=checksum_${file//[\/ ]/_} # Replace all '/' and ' ' by '_'
|
|
||||||
local checksum_value=$(ynh_app_setting_get $app $checksum_setting_name)
|
|
||||||
if [ -n "$checksum_value" ]
|
|
||||||
then # Proceed only if a value was stored into the app settings
|
|
||||||
if ! echo "$checksum_value $file" | sudo md5sum -c --status
|
|
||||||
then # If the checksum is now different
|
|
||||||
backup_file="/home/yunohost.conf/backup/$file.backup.$(date '+%Y%m%d.%H%M%S')"
|
|
||||||
sudo mkdir -p "$(dirname "$backup_file")"
|
|
||||||
sudo cp -a "$file" "$backup_file" # Backup the current file
|
|
||||||
echo "File $file has been manually modified since the installation or last upgrade. So it has been duplicated in $backup_file" >&2
|
|
||||||
echo "$backup_file" # Return the name of the backup file
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
|
||||||
104
scripts/backup
104
scripts/backup
|
|
@ -1,101 +1,77 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Exit on command errors and treat unset variables as an error
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# GENERIC STARTING
|
# GENERIC START
|
||||||
#=================================================
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# IMPORT GENERIC HELPERS
|
# IMPORT GENERIC HELPERS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
if [ ! -e _common.sh ]; then
|
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
|
||||||
# Get the functions file if not present in the current directory
|
source ../settings/scripts/_common.sh
|
||||||
sudo cp ../settings/scripts/_common.sh ./_common.sh
|
|
||||||
sudo chmod a+rx _common.sh
|
|
||||||
fi
|
|
||||||
source _common.sh
|
|
||||||
source /usr/share/yunohost/helpers
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# MANAGE SCRIPT FAILURE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_clean_setup () {
|
||||||
|
true
|
||||||
|
}
|
||||||
|
# Exit if an error occurs during the execution of the script
|
||||||
|
ynh_abort_if_errors
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# LOAD SETTINGS
|
# LOAD SETTINGS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
ynh_print_info --message="Loading installation settings..."
|
||||||
|
|
||||||
app=$YNH_APP_INSTANCE_NAME
|
app=$YNH_APP_INSTANCE_NAME
|
||||||
|
|
||||||
port=$(ynh_app_setting_get $app port)
|
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
||||||
domain=$(ynh_app_setting_get $app domain)
|
domain=$(ynh_app_setting_get --app=$app --key=domain)
|
||||||
is_public=$(ynh_app_setting_get $app is_public)
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
||||||
|
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
|
||||||
wwwhome=~wwwdata
|
|
||||||
final_path="$wwwhome/$app"
|
|
||||||
#=================================================
|
|
||||||
# STANDARD BACKUP STEPS
|
|
||||||
#=================================================
|
|
||||||
# BACKUP OF THE BDD AND ITS CONFIGURATION
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# Backup the configuration
|
|
||||||
CHECK_SIZE "/etc/rethinkdb/instances.d/turtl.conf"
|
|
||||||
ynh_backup "/etc/rethinkdb/instances.d/turtl.conf"
|
|
||||||
|
|
||||||
# Dump data
|
|
||||||
/usr/local/bin/rethinkdb dump -q --overwrite-file -f "$final_path/rethinkdb_dump.tar.gz"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP OF THE MAIN DIR OF THE APP
|
# DECLARE DATA AND CONF FILES TO BACKUP
|
||||||
#=================================================
|
#=================================================
|
||||||
CHECK_SIZE "$final_path"
|
ynh_print_info --message="Declaring files to be backed up..."
|
||||||
ynh_backup "$final_path"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP OF THE SYSTEMD SERVICE
|
# BACKUP THE APP MAIN DIR
|
||||||
#=================================================
|
#=================================================
|
||||||
CHECK_SIZE "/etc/systemd/system/$app.service"
|
|
||||||
ynh_backup "/etc/systemd/system/$app.service"
|
ynh_backup --src_path="$final_path"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP OF THE NGINX CONFIGURATION
|
# BACKUP THE DATA DIR
|
||||||
#=================================================
|
#=================================================
|
||||||
CHECK_SIZE "/etc/nginx/conf.d/$domain.d/$app.conf"
|
|
||||||
ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
|
ynh_backup --src_path="$datadir" --is_big
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# BACKUP THE NGINX CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# SPECIFIC BACKUP
|
# SPECIFIC BACKUP
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP OF APT PREFERENCES AND SOURCES.LIST
|
# BACKUP SYSTEMD
|
||||||
#=================================================
|
#=================================================
|
||||||
CHECK_SIZE "/etc/apt/sources.list.d/$app.list"
|
|
||||||
ynh_backup "/etc/apt/sources.list.d/$app.list"
|
|
||||||
|
|
||||||
CHECK_SIZE "/etc/apt/preferences.d/00TurtlPinning"
|
ynh_backup --src_path="/etc/systemd/system/$app.service"
|
||||||
ynh_backup "/etc/apt/preferences.d/00TurtlPinning"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP OF CCL DIRECTORIES
|
# BACKUP THE MYSQL DATABASE
|
||||||
#=================================================
|
#=================================================
|
||||||
CHECK_SIZE "$wwwhome/.ccl-init.lisp"
|
ynh_print_info --message="Backing up the PostgreSQL database..."
|
||||||
ynh_backup "$wwwhome/.ccl-init.lisp"
|
|
||||||
CHECK_SIZE "$wwwhome/quicklisp"
|
ynh_psql_dump_db --database="$db_name" > db.sql
|
||||||
ynh_backup "$wwwhome/quicklisp"
|
|
||||||
CHECK_SIZE "$wwwhome/.cache"
|
|
||||||
ynh_backup "$wwwhome/.cache"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP OF RSYSLOG CONFIGURATION
|
# END OF SCRIPT
|
||||||
#=================================================
|
#=================================================
|
||||||
CHECK_SIZE "/etc/rsyslog.d/$app.conf"
|
|
||||||
ynh_backup "/etc/rsyslog.d/$app.conf"
|
|
||||||
|
|
||||||
#=================================================
|
ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
|
||||||
# BACKUP OF LOGS
|
|
||||||
#=================================================
|
|
||||||
CHECK_SIZE "/var/log/turtl"
|
|
||||||
ynh_backup "/var/log/turtl"
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# BACKUP OF LOGROTATE CONFIGURATION
|
|
||||||
#=================================================
|
|
||||||
CHECK_SIZE "/etc/logrotate.d/$app"
|
|
||||||
ynh_backup "/etc/logrotate.d/$app"
|
|
||||||
|
|
|
||||||
317
scripts/install
317
scripts/install
|
|
@ -1,7 +1,7 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
set -eu
|
#=================================================
|
||||||
|
# GENERIC START
|
||||||
#=================================================
|
#=================================================
|
||||||
# IMPORT GENERIC HELPERS
|
# IMPORT GENERIC HELPERS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -10,198 +10,191 @@ source _common.sh
|
||||||
source /usr/share/yunohost/helpers
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# MANAGE FAILURE OF THE SCRIPT
|
# MANAGE SCRIPT FAILURE
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée.
|
ynh_clean_setup () {
|
||||||
|
ynh_clean_check_starting
|
||||||
|
}
|
||||||
|
# Exit if an error occurs during the execution of the script
|
||||||
|
ynh_abort_if_errors
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# RETRIEVE ARGUMENTS FROM THE MANIFEST
|
# RETRIEVE ARGUMENTS FROM THE MANIFEST
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
app=$YNH_APP_INSTANCE_NAME
|
|
||||||
|
|
||||||
path=$YNH_APP_ARG_PATH
|
|
||||||
domain=$YNH_APP_ARG_DOMAIN
|
domain=$YNH_APP_ARG_DOMAIN
|
||||||
|
path_url="/"
|
||||||
is_public=$YNH_APP_ARG_IS_PUBLIC
|
is_public=$YNH_APP_ARG_IS_PUBLIC
|
||||||
|
|
||||||
#=================================================
|
hash=$(ynh_string_random --length=128)
|
||||||
# CHECK THE DEBIAN'S CODENAME
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
codename=$(lsb_release -a 2>/dev/null | grep Codename | cut -f 2)
|
app=$YNH_APP_INSTANCE_NAME
|
||||||
test -z "$codename" && (ynh_die "codename empty")
|
|
||||||
if [ $codename != 'jessie' ]
|
#=================================================
|
||||||
then
|
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
|
||||||
ynh_die "Sorry, it can only be installed on Debian Jessie"
|
#=================================================
|
||||||
fi
|
ynh_script_progression --message="Validating installation parameters..." --weight=1
|
||||||
archi=$(uname -m)
|
|
||||||
pwd=$(pwd)
|
final_path=/var/www/$app
|
||||||
wwwhome=~www-data
|
test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
|
||||||
|
|
||||||
|
# Register (book) web path
|
||||||
|
ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# STORE SETTINGS FROM MANIFEST
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Storing installation settings..." --weight=1
|
||||||
|
|
||||||
|
ynh_app_setting_set --app=$app --key=domain --value=$domain
|
||||||
|
ynh_app_setting_set --app=$app --key=path --value=$path_url
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# FIND AND OPEN A PORT
|
# FIND AND OPEN A PORT
|
||||||
#=================================================
|
#=================================================
|
||||||
|
ynh_script_progression --message="Finding an available port..." --weight=2
|
||||||
|
|
||||||
port=$(ynh_find_port 8181) # Cherche un port libre.
|
# Find an available port
|
||||||
|
port=$(ynh_find_port --port=8181)
|
||||||
# Store infos in YunoHost config
|
ynh_app_setting_set --app=$app --key=port --value=$port
|
||||||
ynh_app_setting_set $app port $port
|
|
||||||
ynh_app_setting_set $app path ${path}
|
|
||||||
ynh_app_setting_set $app domain ${domain}
|
|
||||||
ynh_app_setting_set $app is_public ${is_public}
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# DEPENDENCIES
|
# INSTALL DEPENDENCIES
|
||||||
#=================================================
|
#=================================================
|
||||||
# Activate backports sources.list
|
ynh_script_progression --message="Installing dependencies..." --weight=20
|
||||||
cp -a "../conf/turtl.list" "/etc/apt/sources.list.d/$app.list"
|
|
||||||
cp -a "../conf/turtl-preferences" "/etc/apt/preferences.d/00TurtlPinning"
|
|
||||||
if [ $archi == "armv7l" ]
|
|
||||||
then
|
|
||||||
gpg --list-keys 7638D0442B90D010 > /dev/null 2>&1
|
|
||||||
if [ $? != 0 ]
|
|
||||||
then
|
|
||||||
gpg --keyserver pgpkeys.mit.edu --recv-key 7638D0442B90D010
|
|
||||||
fi
|
|
||||||
gpg --list-keys 8B48AD6246925553 > /dev/null 2>&1
|
|
||||||
if [ $? != 0 ]
|
|
||||||
then
|
|
||||||
gpg --keyserver pgpkeys.mit.edu --recv-key 8B48AD6246925553
|
|
||||||
fi
|
|
||||||
if [ $(apt-key finger | grep "7638 D044 2B90 D010" -c) == 0 ]
|
|
||||||
then
|
|
||||||
gpg -a --export 7638D0442B90D010 | apt-key add -
|
|
||||||
fi
|
|
||||||
if [ $(apt-key finger | grep "8B48 AD62 4692 5553" -c) == 0 ]
|
|
||||||
then
|
|
||||||
gpg -a --export 8B48AD6246925553 | apt-key add -
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ $archi == "armv7l" ]
|
ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
|
||||||
then
|
ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
|
||||||
# Install RethinkDB
|
|
||||||
dpkg -i ../conf/rethinkdb_2.3.6_armhf.deb
|
|
||||||
else
|
|
||||||
# Activate RethinkDB sources.list
|
|
||||||
release=$(lsb_release -cs)
|
|
||||||
echo "deb http://download.rethinkdb.com/apt $release main" | tee /etc/apt/sources.list.d/rethinkdb.list
|
|
||||||
wget -qO- https://download.rethinkdb.com/apt/pubkey.gpg | apt-key add -
|
|
||||||
ynh_package_update
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Install dependencies
|
|
||||||
ynh_package_update
|
|
||||||
ynh_install_app_dependencies wget git build-essential rethinkdb libuv1-dev python-pip
|
|
||||||
|
|
||||||
|
|
||||||
# Install Clozure Common Lisp
|
|
||||||
cd /opt
|
|
||||||
if [ $archi == "armv7l" ]
|
|
||||||
then
|
|
||||||
wget -q ftp://ftp.clozure.com/pub/release/1.11/ccl-1.11-linuxarm.tar.gz
|
|
||||||
tar xf ccl-1.11-linuxarm.tar.gz
|
|
||||||
else
|
|
||||||
wget -q ftp://ftp.clozure.com/pub/release/1.11/ccl-1.11-linuxx86.tar.gz
|
|
||||||
tar xf ccl-1.11-linuxx86.tar.gz
|
|
||||||
fi
|
|
||||||
|
|
||||||
cd ccl
|
|
||||||
if [ $(grep -c "flags.* lm .*" /proc/cpuinfo) -eq 0 ]
|
|
||||||
then
|
|
||||||
cp scripts/ccl /usr/bin/ccl
|
|
||||||
else
|
|
||||||
cp scripts/ccl64 /usr/bin/ccl
|
|
||||||
fi
|
|
||||||
sed -e "s@CCL_DEFAULT_DIRECTORY=/usr/local/src/ccl@CCL_DEFAULT_DIRECTORY=/opt/ccl@" -i /usr/bin/ccl
|
|
||||||
|
|
||||||
# Install QuickLisp
|
|
||||||
cd $pwd
|
|
||||||
cp -a ../conf/ccl-init.lisp $wwwhome/.ccl-init.lisp
|
|
||||||
cp -a ../conf/quicklisp.lisp /tmp/quicklisp.lisp
|
|
||||||
cp -a ../conf/quicklisp.lisp.asc /tmp/quicklisp.lisp.asc
|
|
||||||
|
|
||||||
mkdir $wwwhome/quicklisp $wwwhome/.cache/
|
|
||||||
chown www-data: $wwwhome/quicklisp $wwwhome/.cache/ $wwwhome/.ccl-init.lisp
|
|
||||||
|
|
||||||
gpg --keyserver pgpkeys.mit.edu --recv-key 307965AB028B5FF7
|
|
||||||
gpg --verify /tmp/quicklisp.lisp.asc /tmp/quicklisp.lisp
|
|
||||||
|
|
||||||
su -c 'echo -e "(quicklisp-quickstart:install)\n(quit)" | ccl --load /tmp/quicklisp.lisp' -s /bin/bash www-data
|
|
||||||
|
|
||||||
echo "(pushnew \"./\" asdf :*central-registry* :test #'equal)" >> $wwwhome/.ccl-init.lisp
|
|
||||||
|
|
||||||
rm -f /tmp/quicklisp /tmp/quicklisp.lisp.asc
|
|
||||||
|
|
||||||
# Configure RethinkDB
|
|
||||||
echo "http-port=8091" > /etc/rethinkdb/instances.d/turtl.conf
|
|
||||||
service rethinkdb restart
|
|
||||||
|
|
||||||
# Install RethinkDB tools (needed for backup)
|
|
||||||
pip install rethinkdb
|
|
||||||
|
|
||||||
# Install Turtl
|
|
||||||
cd $wwwhome
|
|
||||||
mkdir turtl/data -p
|
|
||||||
cd turtl
|
|
||||||
git clone https://github.com/turtl/api.git
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# CONFIGURE TURTL
|
# CREATE DEDICATED USER
|
||||||
#=================================================
|
#=================================================
|
||||||
cd api
|
ynh_script_progression --message="Configuring system user..." --weight=1
|
||||||
|
|
||||||
# Copions le modèle de fichier de configuration
|
# Create a system user
|
||||||
cp config/config.default.lisp config/config.lisp
|
ynh_system_user_create --username=$app --home_dir="$final_path"
|
||||||
|
|
||||||
# Modifie la configuration de turtl
|
#=================================================
|
||||||
sed -e "s@\*server-port\* 8181@*server-port* $port@" \
|
# CREATE A POSTGRESQL DATABASE
|
||||||
-e "s@\*server-bind\* nil@*server-bind* \"127.0.0.1\"@" \
|
#=================================================
|
||||||
-e "s@\*production-error-handling\* nil@*production-error-handling* t@" \
|
ynh_script_progression --message="Creating a PostgreSQL database..." --weight=2
|
||||||
-e "s@\*site-url\* \"http://turtl.dev:8181\"@*site-url* \"https://$domain\"@" \
|
|
||||||
-e "s@\*smtp-host\* nil@*smtp-host* \"localhost\"@" \
|
|
||||||
-e "s@\*display-errors\* t@*display-errors* nil@" \
|
|
||||||
-e "s@\*local-upload\* nil@*local-upload* \"$wwwhome/turtl/data\"@" \
|
|
||||||
-e "s@\*local-upload-url\* nil@*local-upload-url* \"https://$domain\"@" \
|
|
||||||
-i config/config.lisp
|
|
||||||
|
|
||||||
if [ $path != '/' ]
|
db_name=$(ynh_sanitize_dbid --db_name=$app)
|
||||||
|
db_user=$db_name
|
||||||
|
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
|
||||||
|
ynh_psql_test_if_first_run
|
||||||
|
ynh_psql_setup_db --db_user=$db_user --db_name=$db_name
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Setting up source files..." --weight=3
|
||||||
|
|
||||||
|
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
|
||||||
|
# Download, check integrity, uncompress and patch the source from app.src
|
||||||
|
ynh_setup_source --dest_dir="$final_path"
|
||||||
|
|
||||||
|
mkdir -p $final_path/plugins
|
||||||
|
|
||||||
|
chmod 700 $final_path/plugins
|
||||||
|
chown $app:$app $final_path/plugins
|
||||||
|
|
||||||
|
chmod 750 "$final_path"
|
||||||
|
chmod -R o-rwx "$final_path"
|
||||||
|
chown -R $app:www-data "$final_path"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# NGINX CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Configuring NGINX web server..." --weight=1
|
||||||
|
|
||||||
|
# Create a dedicated NGINX config
|
||||||
|
ynh_add_nginx_config
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SPECIFIC SETUP
|
||||||
|
#=================================================
|
||||||
|
# BUILD TURTLE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Building turtl... (this will take some time and resources!)" --weight=20
|
||||||
|
|
||||||
|
pushd $final_path
|
||||||
|
ynh_use_nodejs
|
||||||
|
ynh_exec_as $app env $ynh_node_load_PATH npm install --unsafe-perm 2>/dev/null
|
||||||
|
popd
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# CREATE DATA DIRECTORY
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Creating a data directory..." --weight=2
|
||||||
|
|
||||||
|
datadir=/home/yunohost.app/$app
|
||||||
|
ynh_app_setting_set --app=$app --key=datadir --value=$datadir
|
||||||
|
|
||||||
|
mkdir -p $datadir
|
||||||
|
|
||||||
|
chmod 750 "$datadir"
|
||||||
|
chmod -R o-rwx "$datadir"
|
||||||
|
chown -R $app:www-data "$datadir"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# ADD A CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Adding a configuration file..." --weight=1
|
||||||
|
|
||||||
|
ynh_add_config --template="../conf/config.yaml.default" --destination="$final_path/config/config.yaml"
|
||||||
|
|
||||||
|
chmod 400 "$final_path/config/config.yaml"
|
||||||
|
chown $app:$app "$final_path/config/config.yaml"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SETUP SYSTEMD
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Configuring a systemd service..." --weight=2
|
||||||
|
|
||||||
|
# Create a dedicated systemd config
|
||||||
|
ynh_add_systemd_config
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# GENERIC FINALIZATION
|
||||||
|
#=================================================
|
||||||
|
# INTEGRATE SERVICE IN YUNOHOST
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
|
||||||
|
|
||||||
|
yunohost service add $app --description="Share notes, bookmarks, and documents"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# START SYSTEMD SERVICE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Starting a systemd service..." --weight=5
|
||||||
|
|
||||||
|
# Start a systemd service
|
||||||
|
ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Listening for turtls on IP"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SETUP SSOWAT
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Configuring permissions..." --weight=1
|
||||||
|
|
||||||
|
# Make app public if necessary
|
||||||
|
if [ $is_public -eq 1 ]
|
||||||
then
|
then
|
||||||
sed -e "s@\*api-path\* \"\"@\*api-path\* \"$path\"@" -i config/config.lisp
|
# Everyone can access the app.
|
||||||
|
# The "main" permission is automatically created before the install script.
|
||||||
|
ynh_permission_update --permission="main" --add="visitors"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# LOG HANDLING
|
# RELOAD NGINX
|
||||||
#=================================================
|
#=================================================
|
||||||
cd $pwd
|
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
|
||||||
cp "../conf/rsyslogd.conf" "/etc/rsyslog.d/$app.conf"
|
|
||||||
service rsyslog restart
|
ynh_systemd_action --service_name=nginx --action=reload
|
||||||
mkdir /var/log/turtl/ -p
|
|
||||||
cp "../conf/logrotate.conf" "/etc/logrotate.d/$app"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# ENABLE SERVICE IN ADMIN PANEL
|
# END OF SCRIPT
|
||||||
#=================================================
|
#=================================================
|
||||||
# Add service to Yunohost monitoring
|
|
||||||
cp "../conf/turtl.service" "/etc/systemd/system/$app.service"
|
|
||||||
systemctl daemon-reload
|
|
||||||
yunohost service add turtl --log "/var/log/turtl/$app.log"
|
|
||||||
yunohost service start turtl
|
|
||||||
|
|
||||||
#=================================================
|
ynh_script_progression --message="Installation of $app completed" --last
|
||||||
# NGINX
|
|
||||||
#=================================================
|
|
||||||
# Copy Nginx conf
|
|
||||||
cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
|
|
||||||
|
|
||||||
# Change variables in Nginx configuration
|
|
||||||
if [ $is_public -eq 1 ];
|
|
||||||
then
|
|
||||||
ynh_app_setting_set "$app" unprotected_uris "$path"
|
|
||||||
fi
|
|
||||||
sed -i "s@__PATH__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf
|
|
||||||
sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf
|
|
||||||
|
|
||||||
# Reload Nginx
|
|
||||||
service nginx reload
|
|
||||||
|
|
|
||||||
113
scripts/remove
113
scripts/remove
|
|
@ -1,9 +1,7 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
set -u
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# GENERIC STARTING
|
# GENERIC START
|
||||||
#=================================================
|
#=================================================
|
||||||
# IMPORT GENERIC HELPERS
|
# IMPORT GENERIC HELPERS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -14,53 +12,92 @@ source /usr/share/yunohost/helpers
|
||||||
#=================================================
|
#=================================================
|
||||||
# LOAD SETTINGS
|
# LOAD SETTINGS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
ynh_script_progression --message="Loading installation settings..." --weight=1
|
||||||
|
|
||||||
app=$YNH_APP_INSTANCE_NAME
|
app=$YNH_APP_INSTANCE_NAME
|
||||||
|
|
||||||
domain=$(ynh_app_setting_get "$app" domain)
|
domain=$(ynh_app_setting_get --app=$app --key=domain)
|
||||||
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
||||||
|
db_user=$db_name
|
||||||
|
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
||||||
|
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# STANDARD REMOVE
|
# STANDARD REMOVE
|
||||||
#=================================================
|
#=================================================
|
||||||
# DISABLE SERVICE IN ADMIN PANEL
|
# REMOVE SERVICE INTEGRATION IN YUNOHOST
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
# Retire le service du monitoring de Yunohost.
|
# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
|
||||||
if sudo yunohost service status | grep -q turtl # Test l'existence du service dans Yunohost
|
if ynh_exec_warn_less yunohost service status $app >/dev/null
|
||||||
then
|
then
|
||||||
echo "Remove turtl service"
|
ynh_script_progression --message="Removing $app service integration..." --weight=1
|
||||||
sudo systemctl stop turtl
|
yunohost service remove $app
|
||||||
sudo systemctl disable turtl
|
|
||||||
ynh_secure_remove "/etc/systemd/system/turtl.service"
|
|
||||||
sudo systemctl daemon-reload
|
|
||||||
sudo yunohost service remove turtl
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# SPECIFIC REMOVE
|
# STOP AND REMOVE SERVICE
|
||||||
#=================================================
|
#=================================================
|
||||||
# REMOVE TURTL
|
ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1
|
||||||
#=================================================
|
|
||||||
# Remove sources
|
|
||||||
sudo rm -rf "/var/www/$app/"
|
|
||||||
# Remove dependencies
|
|
||||||
sudo pip uninstall rethinkdb -y
|
|
||||||
ynh_remove_app_dependencies
|
|
||||||
ynh_secure_remove "/etc/rethinkdb/instances.d/turtl.conf"
|
|
||||||
sudo rm -rf "/var/lib/rethinkdb/turtl"
|
|
||||||
sudo rm -rf "/var/www/.cache/"
|
|
||||||
sudo rm -rf "/var/www/quicklisp/"
|
|
||||||
sudo rm -rf "/opt/ccl/"
|
|
||||||
ynh_secure_remove "/var/www/.ccl-init.lisp"
|
|
||||||
ynh_secure_remove "/usr/bin/ccl"
|
|
||||||
ynh_secure_remove "/etc/logrotate.d/turtl"
|
|
||||||
ynh_secure_remove "/etc/rsyslog.d/turtl.conf"
|
|
||||||
sudo rm -rf "/var/log/turtl/"
|
|
||||||
sudo service rsyslog restart
|
|
||||||
# Remove source.list
|
|
||||||
ynh_secure_remove "/etc/apt/sources.list.d/turtl.list"
|
|
||||||
# Remove nginx configuration file
|
|
||||||
ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf"
|
|
||||||
|
|
||||||
# Reload nginx service
|
# Remove the dedicated systemd config
|
||||||
sudo service nginx reload
|
ynh_remove_systemd_config
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# REMOVE THE POSTGRESQL DATABASE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Removing the PostgreSQL database..." --weight=1
|
||||||
|
|
||||||
|
# Remove a database if it exists, along with the associated user
|
||||||
|
ynh_psql_remove_db --db_user=$db_user --db_name=$db_name
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# REMOVE APP MAIN DIR
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Removing app main directory..." --weight=2
|
||||||
|
|
||||||
|
# Remove the app directory securely
|
||||||
|
ynh_secure_remove --file="$final_path"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# REMOVE DATA DIR
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Remove the data directory if --purge option is used
|
||||||
|
if [ "${YNH_APP_PURGE:-0}" -eq 1 ]
|
||||||
|
then
|
||||||
|
ynh_script_progression --message="Removing app data directory..." --weight=1
|
||||||
|
ynh_secure_remove --file="$datadir"
|
||||||
|
fi
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# REMOVE NGINX CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
|
||||||
|
|
||||||
|
# Remove the dedicated NGINX config
|
||||||
|
ynh_remove_nginx_config
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# REMOVE DEPENDENCIES
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Removing dependencies..." --weight=3
|
||||||
|
|
||||||
|
# Remove metapackage and its dependencies
|
||||||
|
ynh_remove_app_dependencies
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# GENERIC FINALIZATION
|
||||||
|
#=================================================
|
||||||
|
# REMOVE DEDICATED USER
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Removing the dedicated system user..." --weight=1
|
||||||
|
|
||||||
|
# Delete a system user
|
||||||
|
ynh_system_user_delete --username=$app
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# END OF SCRIPT
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_script_progression --message="Removal of $app completed" --last
|
||||||
|
|
|
||||||
176
scripts/restore
176
scripts/restore
|
|
@ -6,162 +6,136 @@
|
||||||
# IMPORT GENERIC HELPERS
|
# IMPORT GENERIC HELPERS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
if [ ! -e _common.sh ]; then
|
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
|
||||||
# Get the _common.sh file if it's not in the current directory
|
source ../settings/scripts/_common.sh
|
||||||
cp ../settings/scripts/_common.sh ./_common.sh
|
|
||||||
chmod a+rx _common.sh
|
|
||||||
fi
|
|
||||||
source _common.sh
|
|
||||||
source /usr/share/yunohost/helpers
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# MANAGE SCRIPT FAILURE
|
# MANAGE SCRIPT FAILURE
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
|
ynh_clean_setup () {
|
||||||
|
ynh_clean_check_starting
|
||||||
|
}
|
||||||
# Exit if an error occurs during the execution of the script
|
# Exit if an error occurs during the execution of the script
|
||||||
ynh_abort_if_errors
|
ynh_abort_if_errors
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# LOAD SETTINGS
|
# LOAD SETTINGS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
ynh_script_progression --message="Loading installation settings..." --weight=1
|
||||||
|
|
||||||
app=$YNH_APP_INSTANCE_NAME
|
app=$YNH_APP_INSTANCE_NAME
|
||||||
|
|
||||||
path=$(ynh_app_setting_get $app path)
|
domain=$(ynh_app_setting_get --app=$app --key=domain)
|
||||||
port=$(ynh_app_setting_get $app port)
|
path_url=$(ynh_app_setting_get --app=$app --key=path)
|
||||||
domain=$(ynh_app_setting_get $app domain)
|
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
||||||
is_public=$(ynh_app_setting_get $app is_public)
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
||||||
|
db_user=$db_name
|
||||||
wwwhome=~wwwdata
|
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
|
||||||
final_path="$wwwhome/$app"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# CHECK IF THE APP CAN BE RESTORED
|
# CHECK IF THE APP CAN BE RESTORED
|
||||||
#=================================================
|
#=================================================
|
||||||
|
ynh_script_progression --message="Validating restoration parameters..." --weight=1
|
||||||
|
|
||||||
yunohost app checkurl "${domain}${path_url}" -a "$app" \
|
|
||||||
test ! -d $final_path \
|
test ! -d $final_path \
|
||||||
|| ynh_die "There is already a directory: $final_path "
|
|| ynh_die --message="There is already a directory: $final_path "
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# RESTORE OF THE NGINX CONFIGURATION
|
# STANDARD RESTORATION STEPS
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
|
# RESTORE THE NGINX CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Restoring the NGINX configuration..." --weight=1
|
||||||
|
|
||||||
|
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# RESTORE OF THE MAIN DIR OF THE APP
|
# RECREATE THE DEDICATED USER
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_restore_file "$final_path"
|
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"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# HANDLE LOG FILES AND LOGROTATE
|
# RESTORE THE APP MAIN DIR
|
||||||
#=================================================
|
#=================================================
|
||||||
mkdir -p /var/log/turtl
|
ynh_script_progression --message="Restoring the app main directory..." --weight=3
|
||||||
# Restore rsyslog conf
|
|
||||||
ynh_restore_file "/etc/rsyslog.d/$app.conf"
|
ynh_restore_file --origin_path="$final_path"
|
||||||
# Restore logrotate conf
|
|
||||||
ynh_restore_file "/etc/logrotate.d/$app"
|
chmod 750 "$final_path"
|
||||||
|
chmod -R o-rwx "$final_path"
|
||||||
|
chown -R $app:www-data "$final_path"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# APT STUFF
|
# RESTORE THE DATA DIRECTORY
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_restore_file "/etc/apt/sources.list.d/$app.list"
|
ynh_script_progression --message="Restoring the data directory..." --weight=1
|
||||||
ynh_restore_file "/etc/apt/preferences.d/00TurtlPinning"
|
|
||||||
|
ynh_restore_file --origin_path="$datadir" --not_mandatory
|
||||||
|
|
||||||
|
mkdir -p $datadir
|
||||||
|
|
||||||
|
chmod 750 "$datadir"
|
||||||
|
chmod -R o-rwx "$datadir"
|
||||||
|
chown -R $app:www-data "$datadir"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# INSTALL DEPENDENCIES
|
# SPECIFIC RESTORATION
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_package_update
|
# REINSTALL DEPENDENCIES
|
||||||
if ! ynh_package_is_installed "wget" ; then
|
#=================================================
|
||||||
ynh_install_app_dependencies wget
|
ynh_script_progression --message="Reinstalling dependencies..." --weight=20
|
||||||
fi
|
|
||||||
if ! ynh_package_is_installed "git" ; then
|
ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
|
||||||
ynh_install_app_dependencies git
|
ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
|
||||||
fi
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# INSTALL CCL
|
# RESTORE THE POSTGRESQL DATABASE
|
||||||
#=================================================
|
#=================================================
|
||||||
cd /opt
|
ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=6
|
||||||
if [ $archi == "armv7l" ]
|
|
||||||
then
|
|
||||||
wget -q ftp://ftp.clozure.com/pub/release/1.11/ccl-1.11-linuxarm.tar.gz
|
|
||||||
tar xf ccl-1.11-linuxarm.tar.gz
|
|
||||||
else
|
|
||||||
wget -q ftp://ftp.clozure.com/pub/release/1.11/ccl-1.11-linuxx86.tar.gz
|
|
||||||
tar xf ccl-1.11-linuxx86.tar.gz
|
|
||||||
fi
|
|
||||||
|
|
||||||
cd ccl
|
ynh_psql_test_if_first_run
|
||||||
if [ $(grep -c "flags.* lm .*" /proc/cpuinfo) -eq 0 ]
|
db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
|
||||||
then
|
ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
|
||||||
cp scripts/ccl /usr/bin/ccl
|
ynh_psql_execute_file_as_root --file="./db.sql" --database=$db_name
|
||||||
else
|
|
||||||
cp scripts/ccl64 /usr/bin/ccl
|
|
||||||
fi
|
|
||||||
sed -e "s@CCL_DEFAULT_DIRECTORY=/usr/local/src/ccl@CCL_DEFAULT_DIRECTORY=/opt/ccl@" -i /usr/bin/ccl
|
|
||||||
|
|
||||||
# Install some dependencies
|
|
||||||
if [ $archi == "armv7l" ]
|
|
||||||
then
|
|
||||||
gpg --keyserver pgpkeys.mit.edu --recv-key 7638D0442B90D010
|
|
||||||
gpg -a --export 7638D0442B90D010 | apt-key add -
|
|
||||||
fi
|
|
||||||
if ! ynh_package_is_installed "build-essential" ; then
|
|
||||||
ynh_install_app_dependencies build-essential
|
|
||||||
fi
|
|
||||||
ynh_install_app_dependencies libuv1-dev
|
|
||||||
|
|
||||||
ynh_restore_file "$wwwhome/.ccl-init.lisp"
|
|
||||||
ynh_restore_file "$wwwhome/quicklisp"
|
|
||||||
ynh_restore_file "$wwwhome/.cache"
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# INSTALL Rethinkdb
|
# RESTORE SYSTEMD
|
||||||
#=================================================
|
#=================================================
|
||||||
if [ $archi == "armv7l" ]
|
ynh_script_progression --message="Restoring the systemd configuration..." --weight=1
|
||||||
then
|
|
||||||
dpkg -i ../conf/rethinkdb_2.3.6_armhf.deb
|
|
||||||
else
|
|
||||||
release=$(lsb_release -cs)
|
|
||||||
echo "deb http://download.rethinkdb.com/apt $release main" | tee /etc/apt/sources.list.d/rethinkdb.list
|
|
||||||
wget -qO- https://download.rethinkdb.com/apt/pubkey.gpg | apt-key add -
|
|
||||||
ynh_package_update
|
|
||||||
ynh_install_app_dependencies rethinkdb
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "http-port=8091" > /etc/rethinkdb/instances.d/turtl.conf
|
ynh_restore_file --origin_path="/etc/systemd/system/$app.service"
|
||||||
service rethinkdb restart
|
systemctl enable $app.service --quiet
|
||||||
|
|
||||||
# Install RethinkDB tools (needed for backup)
|
|
||||||
ynh_install_app_dependencies python-pip
|
|
||||||
pip install rethinkdb
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# RESTORE OF THE BDD
|
# INTEGRATE SERVICE IN YUNOHOST
|
||||||
#=================================================
|
#=================================================
|
||||||
/usr/local/bin/rethinkdb restore "$final_path/rethinkdb_dump.tar.gz"
|
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
|
||||||
|
|
||||||
|
yunohost service add $app --description="Share notes, bookmarks, and documents"
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# RESTORE SYSTEMD SERVICE
|
# START SYSTEMD SERVICE
|
||||||
#=================================================
|
#=================================================
|
||||||
|
ynh_script_progression --message="Starting a systemd service..." --weight=5
|
||||||
|
|
||||||
ynh_restore_file "/etc/systemd/system/$app.service"
|
ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Listening for turtls on IP"
|
||||||
systemctl daemon-reload
|
|
||||||
systemctl enable $app.service
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# ENABLE SERVICE IN ADMIN PANEL
|
# GENERIC FINALIZATION
|
||||||
#=================================================
|
#=================================================
|
||||||
systemctl daemon-reload
|
# RELOAD NGINX AND PHP-FPM
|
||||||
yunohost service add turtl --log "/var/log/turtl/$app.log"
|
#=================================================
|
||||||
|
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
|
||||||
|
|
||||||
|
ynh_systemd_action --service_name=nginx --action=reload
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# START SERVICE
|
# END OF SCRIPT
|
||||||
#=================================================
|
#=================================================
|
||||||
yunohost service start turtl
|
|
||||||
|
|
||||||
#=================================================
|
ynh_script_progression --message="Restoration completed for $app" --last
|
||||||
# RELOAD NGINX
|
|
||||||
#=================================================
|
|
||||||
systemctl reload nginx
|
|
||||||
|
|
|
||||||
131
scripts/upgrade
131
scripts/upgrade
|
|
@ -1,9 +1,7 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Exit on command errors and treat unset variables as an error
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# GENERIC STARTING
|
# GENERIC START
|
||||||
#=================================================
|
#=================================================
|
||||||
# IMPORT GENERIC HELPERS
|
# IMPORT GENERIC HELPERS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
@ -14,39 +12,134 @@ source /usr/share/yunohost/helpers
|
||||||
#=================================================
|
#=================================================
|
||||||
# LOAD SETTINGS
|
# LOAD SETTINGS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
ynh_script_progression --message="Loading installation settings..." --weight=1
|
||||||
|
|
||||||
app=$YNH_APP_INSTANCE_NAME
|
app=$YNH_APP_INSTANCE_NAME
|
||||||
|
|
||||||
path=$(ynh_app_setting_get $app path)
|
domain=$(ynh_app_setting_get --app=$app --key=domain)
|
||||||
port=$(ynh_app_setting_get $app port)
|
path_url=$(ynh_app_setting_get --app=$app --key=path)
|
||||||
domain=$(ynh_app_setting_get $app domain)
|
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
||||||
is_public=$(ynh_app_setting_get $app path)
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
||||||
|
db_user=$db_name
|
||||||
|
db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
|
||||||
|
port=$(ynh_app_setting_get --app=$app --key=port)
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# FIX OLD THINGS
|
# CHECK VERSION
|
||||||
#=================================================
|
#=================================================
|
||||||
cp ../conf/rsyslogd.conf /etc/rsyslog.d/turtl.conf
|
ynh_script_progression --message="Checking version..."
|
||||||
service rsyslog restart
|
|
||||||
cp ../conf/logrotate.conf /etc/logrotate.d/turtl
|
upgrade_type=$(ynh_check_app_version_changed)
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
|
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
|
||||||
#=================================================
|
#=================================================
|
||||||
|
ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1
|
||||||
|
|
||||||
# Backup the current version of the app
|
# Backup the current version of the app
|
||||||
ynh_backup_before_upgrade
|
ynh_backup_before_upgrade
|
||||||
ynh_clean_setup () {
|
ynh_clean_setup () {
|
||||||
# restore it if the upgrade fails
|
ynh_clean_check_starting
|
||||||
ynh_restore_upgradebackup
|
# Restore it if the upgrade fails
|
||||||
|
ynh_restore_upgradebackup
|
||||||
}
|
}
|
||||||
# Exit if an error occurs during the execution of the script
|
# Exit if an error occurs during the execution of the script
|
||||||
ynh_abort_if_errors
|
ynh_abort_if_errors
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# CHECK THE PATH
|
|
||||||
#=================================================
|
|
||||||
# Verify and correct path syntax
|
|
||||||
path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path.
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# STANDARD UPGRADE STEPS
|
# STANDARD UPGRADE STEPS
|
||||||
#=================================================
|
#=================================================
|
||||||
|
# STOP SYSTEMD SERVICE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Stopping a systemd service..." --weight=1
|
||||||
|
|
||||||
|
ynh_systemd_action --service_name=$app --action="stop" --log_path=systemd --line_match="Stopped Turtl Server"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# ENSURE DOWNWARD COMPATIBILITY
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
|
||||||
|
|
||||||
|
# Cleaning legacy permissions
|
||||||
|
if ynh_legacy_permissions_exists; then
|
||||||
|
ynh_legacy_permissions_delete_all
|
||||||
|
|
||||||
|
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"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
if [ "$upgrade_type" == "UPGRADE_APP" ]
|
||||||
|
then
|
||||||
|
ynh_script_progression --message="Upgrading source files..." --weight=2
|
||||||
|
|
||||||
|
# Download, check integrity, uncompress and patch the source from app.src
|
||||||
|
ynh_setup_source --dest_dir="$final_path"
|
||||||
|
fi
|
||||||
|
|
||||||
|
chmod 750 "$final_path"
|
||||||
|
chmod -R o-rwx "$final_path"
|
||||||
|
chown -R $app:www-data "$final_path"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# NGINX CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2
|
||||||
|
|
||||||
|
# Create a dedicated NGINX config
|
||||||
|
ynh_add_nginx_config
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# UPGRADE DEPENDENCIES
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Upgrading dependencies..." --weight=20
|
||||||
|
|
||||||
|
ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
|
||||||
|
ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SETUP SYSTEMD
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Upgrading systemd configuration..." --weight=1
|
||||||
|
|
||||||
|
# Create a dedicated systemd config
|
||||||
|
ynh_add_systemd_config
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# GENERIC FINALIZATION
|
||||||
|
#=================================================
|
||||||
|
# INTEGRATE SERVICE IN YUNOHOST
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
|
||||||
|
|
||||||
|
yunohost service add $app --description="Share notes, bookmarks, and documents"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# START SYSTEMD SERVICE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Starting a systemd service..." --weight=5
|
||||||
|
|
||||||
|
ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Listening for turtls on IP"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# RELOAD NGINX
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
|
||||||
|
|
||||||
|
ynh_systemd_action --service_name=nginx --action=reload
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# END OF SCRIPT
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_script_progression --message="Upgrade of $app completed" --last
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue