Documentation Request: Improve Self-Host Documentation

[ctriley]

Hi! I'm trying to self-host a y-sweet server. There seems to be little documentation on this. The best guide I've found is the docker-compose.yml file in this repo. However, this doesn't show what env variables are required for s3 support. For that I had to read https://github.com/jamsocket/y-sweet/blob/main/docs/running.md

Additionally, while the README says that y-sweet will pick up your local aws credentials, it actually doesn't work unless you have AWS_ACCESS_KEY_ID set. You cannot use the standard Default Credential Provider Chain.

It would also be great to have an example of how to get an ingress to recognize the service is healthy seeing as it returns a 404 error on /

This should all probably be unified in a more comprehensive example in a readme somewhere.

services:
  y-sweet:
    restart: unless-stopped
    image: ghcr.io/jamsocket/y-sweet:latest
    build:
      dockerfile: Dockerfile
      context: ../crates
    command:
      "y-sweet serve ./data --host 0.0.0.0 --auth AXO33rILFt0ZOP7v9NM8e2u6m1pVWvCS5HI9mYMK --url-prefix=http://localhost/"
    volumes:
      - ./data:/data
    ports:
      - "8080:8080"

[lvothnrv]

Hello,
I’m facing the same issue: I want to self-host Y-Sweet and secure it, but the documentation is really lacking—it’s unbelievable.
Has anyone managed to deploy it and secure it properly ?

Regarding the --auth option, you can use your own key, but there’s a special encoding. How exactly should this be done ? There is a command to generate a secret key, but in a Kubernetes environment, this is really complicated. It would be great to be able to set our own key directly.

[TheUltDev]

Alright so I found out today that Jamsocket was acquired and shutdown :'(
Apparently 2 weeks ago it was shutoff. So the adventure begins...

https://github.com/kat-tax/y-sweet

I forked ysweet, added healthchecks, and set things up for railway hosting.
It will infer the public url from railway so you don't need to set Y_SWEET_URL_PREFIX.
These are the required env variables:

Variable	Notes
Y_SWEET_STORE	Source of truth for bucket + prefix (s3://bucket/folder/subfolder)
Y_SWEET_AUTH	Auth private key, a 30-byte random base64 url-safe string (openssl rand -base64 30 | tr '+/' '-_' | tr -d '=')
AWS_ACCESS_KEY_ID	Obtain from S3 provider (provided when creating R2 API Token)
AWS_SECRET_ACCESS_KEY	Obtain from S3 provider (provided when creating R2 API Token)
AWS_ENDPOINT_URL_S3	Example for R2: https://<account_id>.r2.cloudflarestorage.com
AWS_REGION	auto (required by R2)

I use y-sweet for my service so I will be maintaining my fork.
No features planned other than devops stuff, but if your goals align with mine I will add PRs / address issues.