From 33d636c3d54e58c358c66ba1f70d7c67638e4ef3 Mon Sep 17 00:00:00 2001 From: bgharbi Date: Tue, 7 Nov 2023 16:01:28 +0100 Subject: [PATCH 1/2] 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 From 76a1db2d9f8f4ce6ee4f63bda5935aa11ef48e53 Mon Sep 17 00:00:00 2001 From: bgharbi Date: Tue, 7 Nov 2023 16:27:59 +0100 Subject: [PATCH 2/2] update readme files --- workspaces/netlify-cms-auth/Readme.md | 15 +++++++++++++++ workspaces/netlify-cms/Readme.md | 17 +++++++++++++++++ workspaces/website/readme.md | 2 +- 3 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 workspaces/netlify-cms-auth/Readme.md create mode 100644 workspaces/netlify-cms/Readme.md diff --git a/workspaces/netlify-cms-auth/Readme.md b/workspaces/netlify-cms-auth/Readme.md new file mode 100644 index 0000000000..1b9a982e2a --- /dev/null +++ b/workspaces/netlify-cms-auth/Readme.md @@ -0,0 +1,15 @@ +## Deployment +the CMS auth has a [url callback whitelist](src/callback.ts?plain=63) and is deployed to cloudflare worker with the configuration below: + +| Configuration | Value | +|---------------|-------------------| +| Name | netlify-cms-auth | +| usage model | Unbound | + +### enviroment variables and secrets +#### in cloudflare +| Name | Type | Description | +|----------------------------|---------|-------------------------------------------------| +| OAUTH_GITHUB_CLIENT_ID | Secret | github Oauth client ID (under starknet org) | +| OAUTH_GITHUB_CLIENT_SECRET | Secret | github Oauth client Secret (under starknet org) | + diff --git a/workspaces/netlify-cms/Readme.md b/workspaces/netlify-cms/Readme.md new file mode 100644 index 0000000000..75b3b6698c --- /dev/null +++ b/workspaces/netlify-cms/Readme.md @@ -0,0 +1,17 @@ +## Deployment +the CMS is deployed to cloudflare pages with the configuration below: + +| Configuration | Value | +|---------------|----------------------| +| Name | starknet-netlify-cms | +| usage model | Bundled | + +### environment variables and secrets +#### in github +| Name | Type | Description | +|------------------------|------------|------------------------------------------------------------| +| VITE_LIVE_PREVIEW_URL | Variable | declared in the pipeline (netlify-cms.yml) | +| VITE_GIT_BRANCH_NAME | Variable | declared in the pipeline (netlify-cms.yml) | +| VITE_API_BASE_URL | Variable | declared in the pipeline (netlify-cms.yml) | +| VITE_DATA_URL | Variable | declared in the pipeline (netlify-cms.yml) | +| VITE_BACKEND_AUTH_URL | Variable | CMS auth url -- declared in the pipeline (netlify-cms.yml) | diff --git a/workspaces/website/readme.md b/workspaces/website/readme.md index e80f841611..f7dd6b58e9 100644 --- a/workspaces/website/readme.md +++ b/workspaces/website/readme.md @@ -56,7 +56,7 @@ the starknet website is deployed to cloudflare pages with the configuration belo | Name | starknet-websites | | usage model | Unbound | -### enviroment variables and secrets +### environment variables and secrets #### in github | Name | Type | Description | |-----------------------------|--------|---------------------------------------------------------------|