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 #29 from YunoHost-Apps/testing

Browse source 
Testing
This commit is contained in:
lapineige 2024-03-01 17:57:30 +00:00 • committed by GitHub
commit 31b1001a60
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 35 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -1,5 +1,5 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
@ -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.1~ynh2 **Shipped version:** 0.9.2~ynh1
## Documentation and resources ## Documentation and resources
* Official app website: <https://garagehq.deuxfleurs.fr/> * Official app website: <https://garagehq.deuxfleurs.fr/>

4
README_fr.md
View file

@ -1,5 +1,5 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
@ -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.1~ynh2 **Version incluse :** 0.9.2~ynh1
## Documentations et ressources ## Documentations et ressources
* Site officiel de l’app : <https://garagehq.deuxfleurs.fr/> * Site officiel de l’app : <https://garagehq.deuxfleurs.fr/>

9
conf/garage.toml
View file

@ -22,3 +22,12 @@ bootstrap_peers = []
# pour avoir de la sécurité # pour avoir de la sécurité
api_bind_addr = "[::]:__PORT_API__" api_bind_addr = "[::]:__PORT_API__"
s3_region = "garage" 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

9
doc/ADMIN.md
View file

@ -4,8 +4,10 @@
# Informations 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 (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. * 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`
* 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), or a bigger value if you store many small objects.
## How to use the S3 API from other softwares ## How to use the S3 API from other softwares
@ -14,7 +16,10 @@ 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`. 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 ## 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]`. 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]`.

4
doc/POST_INSTALL.md
View file

@ -4,3 +4,7 @@ Your Garage node have been installed. You can now connect to other nodes with th
bootstrap_peers: __SELF_BOOTSTRAP_PEERS__ bootstrap_peers: __SELF_BOOTSTRAP_PEERS__
Current garage layout: __GARAGE_LAYOUT__ 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__`.

19
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.1~ynh2" version = "0.9.2~ynh1"
maintainers = ["oiseauroch"] maintainers = ["oiseauroch"]
@ -63,19 +63,20 @@ 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.1/x86_64-unknown-linux-musl/garage" amd64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.2/x86_64-unknown-linux-musl/garage"
amd64.sha256 = "7932b8073aaba4521f8fd30a8e4c9dfb1b948a3d9d120d456aa883c5a2d73f50" amd64.sha256 = "5e9ddd7bf397d07cbf9c36630c6871688adbcbf31873127f99c63320459483fc"
arm64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/aarch64-unknown-linux-musl/garage" arm64.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.2/aarch64-unknown-linux-musl/garage"
arm64.sha256 = "b79d83d0332de55d27110aaad9dccfdf464e20f63b748c10d1a49a3d162401c3" arm64.sha256 = "a7fabef132f2f71607df6b2343860c3e0d80ad7fee2e7150d703958a49e37191"
i386.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/i686-unknown-linux-musl/garage" i386.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.2/i686-unknown-linux-musl/garage"
i386.sha256 = "45da5319be845528a3965cdf883c6d052b57ff296ae3d72027c5c3fe8cf5251a" i386.sha256 = "4cea631fb3d110725ed349e435dde911f7a9efe810ccbc670043ea3bb52c5fe4"
armhf.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.1/armv6l-unknown-linux-musleabihf/garage" armhf.url = "https://garagehq.deuxfleurs.fr/_releases/v0.9.2/armv6l-unknown-linux-musleabihf/garage"
armhf.sha256 = "d5a898d7f0eb967d2594ac3a51b60ef3d1acf29fa108d2a61c56b1b810721359" armhf.sha256 = "8fc03edb615e78462a1bd58ccbd083e319b8b8d3f80fe430f2b599d5e4791485"
[resources.ports] [resources.ports]
main.default = 4000 main.default = 4000
main.exposed = "TCP" main.exposed = "TCP"
api.default = 5000 api.default = 5000
web.default = 6000
[resources.system_user] [resources.system_user]