yunohost-apps / garage_ynh

Garage package for YunoHost

Garage for YunoHost

Read this README is other languages.

This package allows you to install Garage quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Garage is an S3-compatible distributed object storage service designed for self-hosting at a small-to-medium scale.

Garage is designed for storage clusters composed of nodes running at different physical locations, in order to easily provide a storage service that replicates data at these different locations and stays available even when some servers are unreachable. Garage also focuses on being lightweight, easy to operate, and highly resilient to machine failures.

Features

• S3 API
• Standalone/self-contained
• Flexible topology
• No RAFT slowing you down
• Several replication modes
• Web server for static websites
• Bucket names as aliases
• Cluster administration API
• Metrics and traces
• Support for changing IP addresses
• K2V API (experimental)

Shipped version: 0.9.2~ynh1

Documentation and resources

• Official app website: https://garagehq.deuxfleurs.fr/
• Official user documentation: https://garagehq.deuxfleurs.fr/documentation/quick-start/
• Official admin documentation: https://garagehq.deuxfleurs.fr/documentation/quick-start/
• Upstream app code repository: https://git.deuxfleurs.fr/Deuxfleurs/garage
• YunoHost Store: https://apps.yunohost.org/app/garage
• Report a bug: https://github.com/YunoHost-Apps/garage_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

sudo yunohost app install https://github.com/YunoHost-Apps/garage_ynh/tree/testing --debug
or
sudo yunohost app upgrade garage -u https://github.com/YunoHost-Apps/garage_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps

garage_ynh's Issues

Feature proposal: switch to another database system ?

As performance might be critical for such a system, maybe it would be good to switch to another database than mysql, as recommended by Garage documentation ? https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#db-engine-since-v0-8-0

What do you think ?

And how can we convert this on Yunohost side ? For both fresh installs and upgrades.

Savagely editing the global nginx conf is "not cool"

cf https://github.com/YunoHost-Apps/garage_ynh/blob/master/scripts/install#L205

• The CI complains about this at the end of the install:

32238 ERROR Packagers /!\ This app manually modified some system configuration files! This should not happen! If you need to do so, you should implement a proper conf_regen hook. Those configuration were affected:
    - /etc/nginx/conf.d/sub.domain.tld.conf

• Admins will see a warning in the diagnosis about this and will be encouraged to force-regen the conf which will undo the change
• If they don't, their nginx conf wont be automatically updated by YunoHost, which may lead to other important issues
• There's no easy way to undo that change in the remove script

The good way to do this is to have a regen conf hook, for example as done in

• https://github.com/YunoHost-Apps/mailman_ynh/blob/master/scripts/install#L120
• https://github.com/YunoHost-Apps/mailman_ynh/blob/master/sources/hooks/conf_regen/98-postfix_mailman

(not sure about having it in sources/hooks/conf_regen, maybe conf/ is simpler)

Better document/name the number of G to allow

There is a required field that says:
number of G to allow. I read the garage docs, but that is not documented there either. What is the G ? Number of gigabytes? Number of nodes in the cluster?

Should we had a client_max_body_size parameter in Nginx ?

In garage Nginx config I don't see the Nginx client_max_body_size parameter, which set the max upload file size.

Should we add that parameter ?

Do not overwrite config file during each update.

The config file (garage.toml) is overwritten on each update… that's an issue, in particular because that mean each update will break the server until user use CLI to change the config file, if they changed the config file.
Shouldn't we change that behavior ? 🤔

#22 (comment)