From 33d636c3d54e58c358c66ba1f70d7c67638e4ef3 Mon Sep 17 00:00:00 2001 From: bgharbi Date: Tue, 7 Nov 2023 16:01:28 +0100 Subject: [PATCH] update readme for starknet website --- workspaces/website/readme.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/workspaces/website/readme.md b/workspaces/website/readme.md index 907d633dd1..e80f841611 100644 --- a/workspaces/website/readme.md +++ b/workspaces/website/readme.md @@ -46,3 +46,38 @@ npm run deploy Note how we define a fetch function at `pageContext.fetch` that is universal: it works for development as well as for the production worker. The trick is to provide a different `fetch()` implementation at [worker/ssr.ts](worker/ssr.ts) and [dev-server/index.js](dev-server/index.js). + + +## Deployment +the starknet website is deployed to cloudflare pages with the configuration below: + +| Configuration | Value | +|---------------|-------------------| +| Name | starknet-websites | +| usage model | Unbound | + +### enviroment variables and secrets +#### in github +| Name | Type | Description | +|-----------------------------|--------|---------------------------------------------------------------| +| ALGOLIA_APP_ID | Secret | algolia app token | +| VITE_ALGOLIA_SEARCH_API_KEY | Secret | algolia api search key token | +| CF_STREAM_URL | Secret | the cloudflare video stream url | +| VITE_ED_VIDEO_ID_1 | Secret | the cloudflare video 1 ID (found in cloudflare video stream) | +| VITE_ED_VIDEO_ID_2 | Secret | the cloudflare video 2 ID (found in cloudflare video stream) | +| VITE_ED_VIDEO_ID_3 | Secret | the cloudflare video 3 ID (found in cloudflare video stream) | +| VITE_ED_VIDEO_ID_4 | Secret | the cloudflare video 4 ID (found in cloudflare video stream) | +#### in Cloudflare pages +| Name | Type | Description | +|------|--------|-----------------| +| YOUTUBE_API_KEY | Secret | youtube api key | + +### Multimedia +#### Videos +Videos are hosted in cloudflare stream service, under videos we have all the video used in starknet.io +#### Images +Images are using cloudflare optimisation service (found under: cloudflare starknet.io domain > speed > optimization > image optimization) with the configuration below enabled +- Polish +- Protocol HTTP/2 +- Protocol HTTP/2 to Origin +- Protocol TLS 1.3