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

Merge pull request #22 from YunoHost-Apps/testing

Browse source 
Testing : v0.9.1 + better documentation (S3 API)
This commit is contained in:
lapineige 2024-02-05 21:00:48 +01:00 • committed by GitHub
commit 556088634e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 29 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -35,7 +35,7 @@ Garage is designed for storage clusters composed of nodes running at different p
- K2V API (experimental) - K2V API (experimental)
**Shipped version:** 0.9.0~ynh1 **Shipped version:** 0.9.1~ynh2
## Documentation and resources ## Documentation and resources
* Official app website: <https://garagehq.deuxfleurs.fr/> * Official app website: <https://garagehq.deuxfleurs.fr/>

2
README_fr.md
View file

@ -35,7 +35,7 @@ Garage is designed for storage clusters composed of nodes running at different p
- K2V API (experimental) - K2V API (experimental)
**Version incluse :** 0.9.0~ynh1 **Version incluse :** 0.9.1~ynh2
## Documentations et ressources ## Documentations et ressources
* Site officiel de l’app : <https://garagehq.deuxfleurs.fr/> * Site officiel de l’app : <https://garagehq.deuxfleurs.fr/>

2
conf/nginx.conf
View file

@ -4,4 +4,6 @@ location __PATH__/ {
proxy_pass http://127.0.0.1:__PORT_API__; proxy_pass http://127.0.0.1:__PORT_API__;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $host; proxy_set_header Host $host;
client_max_body_size 1000M;
} }

16
doc/ADMIN.md
View file

@ -1,12 +1,20 @@
* Limitations : # Limitations
* This application is not usable if you're not part of a cluster with minimun 3 other nodes * 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 * 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: # Informations 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 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 consider that the weight of the node is the size reserved to garage in G (Gigabytes)
* 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. * 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.
# How to run commands for Garage ## How to use the S3 API from other softwares
Garage team provides documentation on how to connect with various software to the S3 cluster : https://garagehq.deuxfleurs.fr/documentation/connect/
This will connect via the S3 API. In Yunohost setup, this is proxied through Nginx reverse proxy. As a result, *to use the S3 API, you need to use port 443* instead of the API port (seen in `garage.toml` configuration).
NB: From local command line (such as awscli https://garagehq.deuxfleurs.fr/documentation/connect/cli/) you can use `localhost:S3API_PORT`.
## How to run commands for Garage
1. Use `yunohost app shell garage` to use the command line in Garage own environnement (don't forget to `exit` at the end). You will be located in `/opt/yunohost/garage/` own directory. 1. Use `yunohost app shell garage` to use the command line in Garage own environnement (don't forget to `exit` at the end). You will be located in `/opt/yunohost/garage/` own directory.
2. Then for each use of the `garage` command, you need to specify the config file as a parameter `garage -c garage.toml [the actions you wish to run]`. 2. Then for each use of the `garage` command, you need to specify the config file as a parameter `garage -c garage.toml [the actions you wish to run]`.

18
manifest.toml
View file

@ -5,7 +5,7 @@ name = "Garage"
description.en = "S3 storage" description.en = "S3 storage"
description.fr = "stockage S3" description.fr = "stockage S3"
version = "0.9.0~ynh1" version = "0.9.1~ynh2"
maintainers = ["oiseauroch"] maintainers = ["oiseauroch"]
@ -63,14 +63,14 @@ ram.runtime = "50M"
[resources.sources.main] [resources.sources.main]
in_subdir = false in_subdir = false
extract = false extract = false
amd64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.0/x86_64-unknown-linux-musl/garage" amd64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/x86_64-unknown-linux-musl/garage"
amd64.sha256 = "3ae4ecb2a75610ab7bfe77bfac7a5c7a8834a0544158ac8ee37723e6d8fd1859" amd64.sha256 = "7932b8073aaba4521f8fd30a8e4c9dfb1b948a3d9d120d456aa883c5a2d73f50"
arm64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.0/aarch64-unknown-linux-musl/garage" arm64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/aarch64-unknown-linux-musl/garage"
arm64.sha256 = "b4db67a618ed493e1803d8bae83e8ea091703763b182d4c62fa1896179b17b9b" arm64.sha256 = "b79d83d0332de55d27110aaad9dccfdf464e20f63b748c10d1a49a3d162401c3"
i386.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.0/i686-unknown-linux-musl/garage" i386.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/i686-unknown-linux-musl/garage"
i386.sha256 = "fcec4c6918ac5ae04829ed9c4f20c7eef0966194eabfe961e6d7f8aee14b0108" i386.sha256 = "45da5319be845528a3965cdf883c6d052b57ff296ae3d72027c5c3fe8cf5251a"
armhf.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.0/armv6l-unknown-linux-musleabihf/garage" armhf.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/armv6l-unknown-linux-musleabihf/garage"
armhf.sha256 = "8f04a38fcafc2ccda652738f2e80b0d2b6443150db0d7165db2de6c75035b4e3" armhf.sha256 = "d5a898d7f0eb967d2594ac3a51b60ef3d1acf29fa108d2a61c56b1b810721359"
[resources.ports] [resources.ports]
main.default = 4000 main.default = 4000