Deuxfleurs/garage
49
56
Fork 73
Code Issues 98 Pull requests 12 Releases 30 Wiki Activity

WIP: Adding ente documentation #826

Draft
tcheronneau wants to merge 2 commits from tcheronneau/garage:main into main
pull from: tcheronneau/garage:main
merge into: Deuxfleurs:main
Conversation 1 Commits 2 Files changed 1 +100
tcheronneau commented 2024-05-24 07:03:58 +00:00
First-time contributor
Copy link

Adding the documentation to configure ente-server (museum) with garage.

Adding the documentation to configure ente-server (museum) with garage.
tcheronneau added 1 commit 2024-05-24 07:03:58 +00:00
Adding ente documentation
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
b98c90f045
maximilien added 1 commit 2024-05-26 06:18:23 +00:00
ente: add more details on bucket configuration
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Details
7e7cb6412d 
add more configuration with details for options

Signed-off-by: maximilien <maximilien@deuxfleurs.fr>
lx commented 2024-08-24 10:50:58 +00:00
Owner
Copy link

Maybe it's worth merging this in its current state even if it is not perfectly complete? @tcheronneau @maximilien

Maybe it's worth merging this in its current state even if it is not perfectly complete? @tcheronneau @maximilien
kaiyou requested changes 2024-09-04 20:21:53 +00:00
kaiyou left a comment
Contributor
Copy link

Thank you really much for the quick guide, which helped me avoid one or two pitfalls when setting up Ente backed up with Garage.

I did find a couple issues however, which are mentionned in the review. The biggest one is the CORS configuration, which currently prevents clients from uploading files.

Thank you really much for the quick guide, which helped me avoid one or two pitfalls when setting up Ente backed up with Garage. I did find a couple issues however, which are mentionned in the review. The biggest one is the CORS configuration, which currently prevents clients from uploading files.
doc/book/connect/apps/index.md
@ -571,0 +578,4 @@
```bash
garage bucket create ente
garage key create ente-key
garage bucket allow ente --read --write --key ente-key
kaiyou commented 2024-09-04 20:20:15 +00:00
Contributor
Copy link

For the CORS setup to work, the key needs to be --owner as well, at least temporarily.

For the CORS setup to work, the key needs to be `--owner` as well, at least temporarily.
doc/book/connect/apps/index.md
@ -571,0 +584,4 @@
We also need to setup some CORS rules to allow the Ente frontend to access the bucket:
```bash
export CORS='{"CORSRules":[{"AllowedHeaders":["*"],"AllowedMethods":["GET"],"AllowedOrigins":["*"]}]}'
kaiyou commented 2024-09-04 20:17:49 +00:00
Contributor
Copy link

Maybe we could be a bit more restrictive in AllowedHeaders even if I cannot think of a threat model where this is important.

However, we must:

Maybe we could be a bit more restrictive in `AllowedHeaders` even if I cannot think of a threat model where this is important. However, we must: - allow at least `PUT`, `POST` and `DELETE` in addition to `GET` so that Ente can upload and delete objects - allow at least `Etag` in `ExposeHeaders` so Ente can read the response Etag when uploading multipart objects (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManageCorsUsing.html#cors-expose-headers, Ente is doing multipart above 5 x 4MB chunks, so >20MB)
doc/book/connect/apps/index.md
@ -571,0 +600,4 @@
local-domain-suffix: "@example.com" # Your domain
local-domain-value: 123456 # Custom One-Time Password since we are not sending mail by default
key:
# You might want to change those next 3 which are the default one
kaiyou commented 2024-09-04 20:18:38 +00:00
Contributor
Copy link

I would say you must, especially the jwt secret.

I would say you `must`, especially the jwt secret.
doc/book/connect/apps/index.md
@ -571,0 +646,4 @@
b2-eu-cen: # Don't change this key, it seems to be hardcoded
key: <keyID>
secret: <keySecret>
endpoint: garage:3900
kaiyou commented 2024-09-04 20:19:30 +00:00
Contributor
Copy link

We should be using the public garage URL here, so Ente can generate proper pre-signed URLs, as used by the clients.

We should be using the public garage URL here, so Ente can generate proper pre-signed URLs, as used by the clients.
All checks were successful
ci/woodpecker/pr/debug Pipeline was successful
Required
Details
This pull request is marked as a work in progress.
This branch is out-of-date with the base branch
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u main:tcheronneau-main
git checkout tcheronneau-main
Sign in to join this conversation.
Reviewers
No reviewers
kaiyou
Labels
Clear labels   
action
check-aws
The behaviour should be checked against AWS S3

  
action
discussion-needed
We need to discuss if the feature is desirable and/or better specify the envisioned behavior or technical implementation

  
action
for-external-contributors
Core team does not plan working on this in the near future however an external contribution will be reviewed & merged

  
action
for-newcomers
An issue that should be newcomer friendly.

  
action
more-info-needed
More information is needed to investigate this issue

  
action
need-funding
This issue represents lots of work, we need to find money to pay our core team work

  
action
triage-required
It's not very clear what we want to do with this issue yet, more thoughts is required

  
kind
correctness
Issues of theoretical correctness that may impact edge-case scenarios

  
kind
ideas
For abstract ideas/proposal to make Garage better, to better communicate our not yet achieved aims

  
kind
improvement
Feature requests that do not fall in other categories

  
kind
performance
Deceptive performance observed OR idea to improve performances

  
kind
testing
Functional tests, integration tests, Jepsen, etc.

  
kind
usability
Propositions to make Garage easier to operate, by improving error reporting, CLI, etc.

  
kind
wrong-behavior
Unintended behavior

  
prio
critical
Could impact integrity or availability of production clusters

  
prio
low
For issues that we don't want to spend time on until made absolutely necessary

  
scope
admin-api
Issues concerning the administration API

  
scope
background-healing
Background healing covers repair tasks, anti-entropy, merkle trees, etc. ; everything related to replicating data appropriately.

  
scope
build
Issues with Nix, Drone, Rust Compiler, etc.

  
scope
documentation

  
scope
k8s
Kubernetes related, including Helm Charts

  
scope
layout
Linked to the cluster layout and storage management

  
scope
metadata
Metadata Engine (LMDB, sqlite, etc.)

  
scope
ops
Operations related to operations/maintenance issue, tooling related (like CLI missing info ; impossible, too dangerous, too complicated migration, etc.)

  
scope
rpc
Linked to RPC

  
scope
s3-api
Related to the S3 API (especially compatibility issues).

  
scope
security
Cryptography-related, auth-related, authorization-related issues

  
scope
telemetry
OpenTelemetry (traces, metrics, etc.)

No labels
action
check-aws
action
discussion-needed
action
for-external-contributors
action
for-newcomers
action
more-info-needed
action
need-funding
action
triage-required
kind
correctness
kind
ideas
kind
improvement
kind
performance
kind
testing
kind
usability
kind
wrong-behavior
prio
critical
prio
low
scope
admin-api
scope
background-healing
scope
build
scope
documentation
scope
k8s
scope
layout
scope
metadata
scope
ops
scope
rpc
scope
s3-api
scope
security
scope
telemetry
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/garage#826
No description provided.
Delete branch "tcheronneau/garage:main"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?