From 1932b08bb1e8786f118196a065de8ee24101695e Mon Sep 17 00:00:00 2001 From: lapineige Date: Mon, 5 Feb 2024 20:34:10 +0100 Subject: [PATCH 01/12] add web endpoint port --- manifest.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/manifest.toml b/manifest.toml index 5a23f7a..a2d93de 100644 --- a/manifest.toml +++ b/manifest.toml @@ -76,6 +76,7 @@ ram.runtime = "50M" main.default = 4000 main.exposed = "TCP" api.default = 5000 + web.default = 6000 [resources.system_user] From 3dfb00323cb31d9a90a57ba2175bf14c99a41496 Mon Sep 17 00:00:00 2001 From: lapineige Date: Mon, 5 Feb 2024 20:36:53 +0100 Subject: [PATCH 02/12] add web endpoint port --- conf/garage.toml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/conf/garage.toml b/conf/garage.toml index 9d84248..d97ea8c 100644 --- a/conf/garage.toml +++ b/conf/garage.toml @@ -22,3 +22,9 @@ bootstrap_peers = [] # pour avoir de la sécurité api_bind_addr = "[::]:__PORT_API__" s3_region = "garage" + +[s3_web] +# Ne supporte pas TLS → reverse proxy obligatoire +# pour avoir de la sécurité +# utilisé pour l'accès public aux buckets (site web, médias d'instance du fediverse…) +bind_addr = "[::]:__PORT_WEB__" From 84f0c9ee47e648ace941b322b4cedaa010df2dc1 Mon Sep 17 00:00:00 2001 From: lapineige Date: Mon, 5 Feb 2024 20:51:30 +0100 Subject: [PATCH 03/12] add root domain parameters For vhost style access (bucketname.domain.tld) --- conf/garage.toml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/conf/garage.toml b/conf/garage.toml index d97ea8c..274e21d 100644 --- a/conf/garage.toml +++ b/conf/garage.toml @@ -22,9 +22,12 @@ bootstrap_peers = [] # pour avoir de la sécurité api_bind_addr = "[::]:__PORT_API__" s3_region = "garage" +root_domain = ".__DOMAIN__" # might be used for vhost (instead of path_style) requests (using "bucketname.__DOMAIN__") according to https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#s3_root_domain [s3_web] # Ne supporte pas TLS → reverse proxy obligatoire # pour avoir de la sécurité # utilisé pour l'accès public aux buckets (site web, médias d'instance du fediverse…) bind_addr = "[::]:__PORT_WEB__" +root_domain = ".__DOMAIN__" # might be used for vhost (instead of path_style) requests (using "bucketname.__DOMAIN__") according to https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#web_root_domain + From 80d03ac6694f75edb98c6e62e3789ec59a46a200 Mon Sep 17 00:00:00 2001 From: lapineige Date: Mon, 5 Feb 2024 21:04:18 +0100 Subject: [PATCH 04/12] bump version --- manifest.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifest.toml b/manifest.toml index a2d93de..a75a480 100644 --- a/manifest.toml +++ b/manifest.toml @@ -5,7 +5,7 @@ name = "Garage" description.en = "S3 storage" description.fr = "stockage S3" -version = "0.9.1~ynh1" +version = "0.9.1~ynh3" maintainers = ["oiseauroch"] From afcd56356d9a063d6d87168679746197876432d5 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Mon, 5 Feb 2024 20:04:22 +0000 Subject: [PATCH 05/12] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d2ed5c4..8a297b2 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Garage is designed for storage clusters composed of nodes running at different p - K2V API (experimental) -**Shipped version:** 0.9.1~ynh1 +**Shipped version:** 0.9.1~ynh3 ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index c8179b8..244d4d6 100644 --- a/README_fr.md +++ b/README_fr.md @@ -35,7 +35,7 @@ Garage is designed for storage clusters composed of nodes running at different p - K2V API (experimental) -**Version incluse :** 0.9.1~ynh1 +**Version incluse :** 0.9.1~ynh3 ## Documentations et ressources * Site officiel de l’app : From a959a64b4c4d00088ffbface331d1ef202f3de6d Mon Sep 17 00:00:00 2001 From: lapineige Date: Mon, 5 Feb 2024 21:19:48 +0100 Subject: [PATCH 06/12] Explain which port is used for what --- doc/POST_INSTALL.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md index b420b12..781da2d 100644 --- a/doc/POST_INSTALL.md +++ b/doc/POST_INSTALL.md @@ -4,3 +4,7 @@ Your Garage node have been installed. You can now connect to other nodes with th bootstrap_peers: __SELF_BOOTSTRAP_PEERS__ Current garage layout: __GARAGE_LAYOUT__ + +The RPC port is __PORT__ +The S3 API port is __PORT_API__ but you should use port 443 (HTTPS reverse proxy with Nginx) in your client settings +The web endpoint (for HTTP public access, for a static website or social media files) is __PORT_WEB__, and if you want to use you should setup website access for the bucket, and a `redirect_ynh` app pointing to `127.0.0.1:__PORT_WEB__`, using the domain `bucketname.__DOMAIN__`. From b09d0c26ea792fb302ac097ec120159fcaa57d4b Mon Sep 17 00:00:00 2001 From: lapineige Date: Mon, 5 Feb 2024 21:22:41 +0100 Subject: [PATCH 07/12] Explain how to use the web endpoint --- doc/ADMIN.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 69cfe4a..bf570bd 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -6,6 +6,7 @@ * 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 (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. + * to connect from another node, you might need the RPC port. Is is defined in `rpc_bind_addr` in your `garage.toml` ## How to use the S3 API from other softwares @@ -14,6 +15,9 @@ This will connect via the S3 API. In Yunohost setup, this is proxied through Ngi NB: From local command line (such as awscli https://garagehq.deuxfleurs.fr/documentation/connect/cli/) you can use `localhost:S3API_PORT`. +## How to use + +The web endpoint (for HTTP public access, for a static website or social media files) is the one defined in `s3_web` in your `garage.toml`, and if you want to use you should setup website access for the bucket, and a `redirect_ynh` app pointing to `127.0.0.1:WEB_PORT`, using the domain `bucketname.DOMAIN`. ## 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. From f5824d6cacd050e6bbc2cae272da1466ae2736b1 Mon Sep 17 00:00:00 2001 From: lapineige Date: Mon, 5 Feb 2024 21:25:56 +0100 Subject: [PATCH 08/12] fix folder path --- doc/ADMIN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ADMIN.md b/doc/ADMIN.md index bf570bd..3d41115 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -20,5 +20,5 @@ NB: From local command line (such as awscli https://garagehq.deuxfleurs.fr/docum The web endpoint (for HTTP public access, for a static website or social media files) is the one defined in `s3_web` in your `garage.toml`, and if you want to use you should setup website access for the bucket, and a `redirect_ynh` app pointing to `127.0.0.1:WEB_PORT`, using the domain `bucketname.DOMAIN`. ## 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 `/var/www/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]`. From b5da5b84514fe0f74df38cd5dfb1c9a7d7dc25fc Mon Sep 17 00:00:00 2001 From: lapineige Date: Wed, 7 Feb 2024 09:11:19 +0100 Subject: [PATCH 09/12] storage consumption documentation --- doc/ADMIN.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 69cfe4a..bd71888 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -4,8 +4,9 @@ # 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 consider that the weight of the node is the size reserved to garage in G (Gigabytes) + * 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. + * Storage consumption : appart from your data storage, you can expect the metadata (database) to consume approximatly 1% of the data size (1GB for 100GB of data for instance). ## How to use the S3 API from other softwares From 5a30a2023396ff93d78d00c9d87ebc2dda588e88 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Fri, 1 Mar 2024 16:54:21 +0000 Subject: [PATCH 10/12] Auto-update README --- README.md | 4 ++-- README_fr.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8a297b2..416a1e6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -57,4 +57,4 @@ or sudo yunohost app upgrade garage -u https://github.com/YunoHost-Apps/garage_ynh/tree/testing --debug ``` -**More info regarding app packaging:** +**More info regarding app packaging:** \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 244d4d6..7a35ac4 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,5 +1,5 @@ From 35772b8c78a6590d9d2e4af2a7b1a66742736008 Mon Sep 17 00:00:00 2001 From: lapineige Date: Fri, 1 Mar 2024 17:59:41 +0100 Subject: [PATCH 11/12] garage 0.9.2 --- manifest.toml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/manifest.toml b/manifest.toml index a75a480..c1b7f94 100644 --- a/manifest.toml +++ b/manifest.toml @@ -5,7 +5,7 @@ name = "Garage" description.en = "S3 storage" description.fr = "stockage S3" -version = "0.9.1~ynh3" +version = "0.9.2~ynh1" maintainers = ["oiseauroch"] @@ -63,14 +63,14 @@ ram.runtime = "50M" [resources.sources.main] in_subdir = false extract = false - amd64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/x86_64-unknown-linux-musl/garage" - amd64.sha256 = "7932b8073aaba4521f8fd30a8e4c9dfb1b948a3d9d120d456aa883c5a2d73f50" - arm64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/aarch64-unknown-linux-musl/garage" - arm64.sha256 = "b79d83d0332de55d27110aaad9dccfdf464e20f63b748c10d1a49a3d162401c3" - i386.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/i686-unknown-linux-musl/garage" - i386.sha256 = "45da5319be845528a3965cdf883c6d052b57ff296ae3d72027c5c3fe8cf5251a" - armhf.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/armv6l-unknown-linux-musleabihf/garage" - armhf.sha256 = "d5a898d7f0eb967d2594ac3a51b60ef3d1acf29fa108d2a61c56b1b810721359" + amd64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.2/x86_64-unknown-linux-musl/garage" + amd64.sha256 = "5e9ddd7bf397d07cbf9c36630c6871688adbcbf31873127f99c63320459483fc" + arm64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.2/aarch64-unknown-linux-musl/garage" + arm64.sha256 = "a7fabef132f2f71607df6b2343860c3e0d80ad7fee2e7150d703958a49e37191" + i386.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.2/i686-unknown-linux-musl/garage" + i386.sha256 = "4cea631fb3d110725ed349e435dde911f7a9efe810ccbc670043ea3bb52c5fe4" + armhf.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.2/armv6l-unknown-linux-musleabihf/garage" + armhf.sha256 = "8fc03edb615e78462a1bd58ccbd083e319b8b8d3f80fe430f2b599d5e4791485" [resources.ports] main.default = 4000 From 7325cd22e35024576ee8002c1b52f2ed219d5da5 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Fri, 1 Mar 2024 16:59:44 +0000 Subject: [PATCH 12/12] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 416a1e6..95ec920 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Garage is designed for storage clusters composed of nodes running at different p - K2V API (experimental) -**Shipped version:** 0.9.1~ynh3 +**Shipped version:** 0.9.2~ynh1 ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 7a35ac4..31a12cc 100644 --- a/README_fr.md +++ b/README_fr.md @@ -35,7 +35,7 @@ Garage is designed for storage clusters composed of nodes running at different p - K2V API (experimental) -**Version incluse :** 0.9.1~ynh3 +**Version incluse :** 0.9.2~ynh1 ## Documentations et ressources * Site officiel de l’app :