YunoHost-Apps/garage_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/garage_ynh.git synced 2024-09-03 18:36:32 +02:00
Code Issues Activity Actions
Garage package for YunoHost
573 commits 7 branches 0 tags 754 KiB
Find a file
Exact
yunohost-bot 8db3d0cafb Auto-update README
2023-03-29 09:05:39 +00:00
.github Update updater.sh 2022-03-24 10:47:23 +01:00
conf fix wrong weight update 2023-02-22 20:55:54 +01:00
doc remove unused ip value 2023-02-24 12:32:30 +01:00
scripts change hook mechanism 2023-03-17 09:57:42 +01:00
sources change hook mechanism 2023-03-17 09:57:42 +01:00
.gitignore export virtualisation var 2022-11-30 11:40:43 +01:00
check_process update check url 2022-12-23 14:16:46 +01:00
config_panel.toml - improve config panel 2023-03-03 15:00:42 +01:00
config_panel.toml.example improve package and begin to add config panel 2022-11-24 00:22:09 +01:00
LICENSE WIP packaging 2022-07-30 14:02:57 +02:00
manifest.json Update manifest.json 2023-03-29 11:05:33 +02:00
README.md Auto-update README 2023-03-29 09:05:39 +00:00
README_fr.md Auto-update README 2023-03-29 09:05:39 +00:00

README.md

Garage for YunoHost

Integration level Working status Maintenance status

Install Garage with YunoHost

Lire ce readme en français.

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.8.0~ynh4

Disclaimers / important information

  • Limitations :

    • This application is not usable if you're not part of a cluster with minimun 3 other nodes
    • If you are behind a nat and use upnp to configure your port redirection, you may need to add peers via config panel instead of during installation and/or create a permanent redirection in your router/box

  • infos you should be aware of:

    • This application provide a node that you can connect to a garage cluster. Few option are manageable by the config panel for the current node but IT DOESN'T offer simpler way to manage bucket and keys. You have to do it by command line or let an other node managing it.
    • This application consider that the weight of the node is the size reserved to garage in G
    • This application will try to create a virtual disk to ensure garage doesn't use more than allowed. If virtualisation is not available your responsible to check space used by garage.

Documentation and resources

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