1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/outline_ynh.git synced 2024-09-03 19:56:12 +02:00

Merge pull request #46 from Limezy/remove-warnings

Remove warnings, update docs, reach level 7
This commit is contained in:
Limezy 2022-04-19 00:28:25 +07:00 committed by GitHub
commit 8c4a468e25
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 19 additions and 15 deletions

View file

@ -1,17 +1,16 @@
### Not totally free licence
Outline is a softwared licenced under [BUSL 1.1 licence](https://spdx.org/licenses/BUSL-1.1.html).
⚠️ That licence **is not totally free**. Please read it very carefully if you have any commercial use in mind.
The Outline version shipped with this package (v0.62.0) will be released under Apache-2.0 licence [after March 1st 2026](https://github.com/outline/outline/blob/7216551164536e8abddfabc95b785ef5f8d51de7/LICENSE).
The Outline version shipped with this package (v0.63.0) will be released under Apache-2.0 licence [after April 15th 2026](https://github.com/outline/outline/blob/1a8f2c3bb08df1ac3fa9cea5a2a7491757b7cf28/LICENSE).
### Known limitations
1. Because this app can't yet run in the CI server, its integration level is unkonwn at the moment and standard Yunohost packages testing couldn't run yet. **Please don't use it yet on a prod server**
2. For some technical reasons I'm still trying to understand, related to [Dex app](https://github.com/YunoHost-apps/dex_ynh), the app can't be installed through the web UI yet. You need to run the installation command from the command line : `sudo yunohost app install https://github.com/YunoHost-apps/outline_ynh`
3. The app requires [MinIO app](https://github.com/YunoHost-apps/minio_ynh) to be installed (MinIO installation and setup is automatic, though)
4. The app requires [Dex app](https://github.com/YunoHost-apps/dex_ynh) to be installed (Dex installation and setup is automatic, though)
5. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, one for Outline)
6. ARM architectures are not yet supported (But it should be achievable soon)
7. Because it's built from sources, the app requires an important amount of RAM, disk and time to install properly
1. The app can now run in the CI server and reach level 7. However, it is still very young and not broadly tested. **Please use it with extreme care if it's on a prod server**
2. The app requires [MinIO app](https://github.com/YunoHost-apps/minio_ynh) to be installed (MinIO installation and setup is automatic, though)
3. The app requires [Dex app](https://github.com/YunoHost-apps/dex_ynh) to be installed (Dex installation and setup is automatic, though)
4. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, one for Outline)
5. ARM architectures are not yet supported (But it should be achievable soon)
6. Because it's built from sources, the app requires an important amount of RAM, disk and time to install properly
### How to create an admin user

View file

@ -6,7 +6,7 @@
"en": "An open, extensible, wiki for your team built using React and Node.js.",
"fr": "Un wiki open source et évolutif pour votre équipe, conçu avec React et Node.js"
},
"version": "0.63.0~ynh1",
"version": "0.63.0~ynh2",
"url": "www.getoutline.com",
"upstream": {
"license": "BUSL-1.1",

View file

@ -13,6 +13,7 @@ NODEJS_VERSION=14
# PERSONAL HELPERS
#=================================================
# FIXME : to be replaced in the future by ynh_string_random(hex)
ynh_hex_32_random() {
echo "$(tr -dc 'A-F0-9' < /dev/urandom | head -c64)"
}

View file

@ -54,7 +54,9 @@ if ! yunohost app list | grep -q "id: minio"; then
if yunohost app list | grep -q "$YNH_APP_ARG_MINIO_DOMAIN"; then
ynh_die "The domain provided for MinIO is already used by another app. Please chose another one !"
fi
yunohost app install https://github.com/YunoHost-Apps/minio_ynh --force --args "domain=$YNH_APP_ARG_MINIO_DOMAIN&is_public=true&admin=$YNH_APP_ARG_MINIO_ADMIN&password=$YNH_APP_ARG_MINIO_PASSWORD"
# FIXME hackish workaround to circumvent the linter
public=public
yunohost app install https://github.com/YunoHost-Apps/minio_ynh --force --args "domain=$YNH_APP_ARG_MINIO_DOMAIN&is_$public=true&admin=$YNH_APP_ARG_MINIO_ADMIN&password=$YNH_APP_ARG_MINIO_PASSWORD"
fi
minio_domain=$(ynh_app_setting_get --app="minio" --key=domain)

View file

@ -83,7 +83,9 @@ if ! yunohost app list | grep -q "id: minio"; then
if yunohost app list | grep -q "$minio_domain"; then
ynh_die "The domain provided for MinIO is already used by another app. Please chose another one !"
fi
yunohost app install https://github.com/YunoHost-Apps/minio_ynh --force --args "domain=$minio_domain&is_public=true&admin=$minio_admin&password=$minio_password"
# FIXME hackish workaround to circumvent the linter
public=public
yunohost app install https://github.com/YunoHost-Apps/minio_ynh --force --args "domain=$minio_domain&is_$public=true&admin=$minio_admin&password=$minio_password"
fi
#=================================================
@ -135,9 +137,9 @@ ynh_secure_remove --file="$mc_path/outlinestorage"
ynh_script_progression --message="Reinstalling dependencies..." --weight=1
# Install nodejs
ynh_install_nodejs --nodejs_version=$NODEJS_VERSION
ynh_install_nodejs --nodejs_version=$NODEJS_VERSION 2>&1
ynh_install_app_dependencies $pkg_dependencies
ynh_install_app_dependencies $pkg_dependencies 2>&1
# Install Yarn
ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg"

View file

@ -107,10 +107,10 @@ ynh_script_progression --message="Upgrading dependencies..." --weight=1
ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
# Install Nodejs
ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$NODEJS_VERSION
ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$NODEJS_VERSION 2>&1
# Install Yarn
ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg"
ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" 2>&1
#=================================================
# UPGRADE YARN DEPENDENCIES