Skip to content

Commit

Permalink
docs: fix rewrite rule region notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jthegedus authored Jul 5, 2021
1 parent 7f59de6 commit e4b759a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,8 @@ Choice is a good thing, hopefully this comparison table helps you decide which c
| ----------------------------------------------------------------- | ------------------ | --------------------------------------------------------------------------------------------------- |
| Firebase Emulator Integration | :heavy_check_mark: | :x: |
| Unified deployment - Firebase Hosting & Compute deployed together | :heavy_check_mark: | :x: |
| Cold start mitigations | :x: stay tuned | :heavy_check_mark: ([`min_instances`](https://cloud.google.com/run/docs/configuring/min-instances)) |
| Cold start mitigations | :x: (stay tuned) | :heavy_check_mark: ([`min_instances`](https://cloud.google.com/run/docs/configuring/min-instances)) |
| Regions | :x: only ```us-central1``` shown in [docs](https://firebase.google.com/docs/hosting/functions) (stay tuned) | :heavy_check_mark: full list in [docs](https://firebase.google.com/docs/hosting/full-config#rewrite-cloud-run-container) |

Cloud Functions seems do be a better default, with some improvements coming in the future.

Expand Down Expand Up @@ -682,7 +683,7 @@ If cold starts are still an issue for your application, Cloud Run has support fo
## Caveats

- [Firebase Hosting Preview Channels](https://firebase.google.com/docs/hosting/test-preview-deploy) currently lacks first-party support for SSR applications. This adapter doesn't attempt to remedy this issue and doesn't produce a different SSR Function/Run for preview channel deployments.
- :warning: while you can specify the region for both, Cloud Run in `firebase.json:run.region` and Cloud Functions in the `runWith({region: ""})` function definition, **`us-central1` is the only valid region for Firebase Hosting rewrites**, other regions will error. The official warning about this can be found in [these docs](https://firebase.google.com/docs/hosting/functions).
- :warning: Cloud Function rewrites only support **us-central1**, other regions will error. The official warning about this can be found in [these docs](https://firebase.google.com/docs/hosting/functions).
<!-- TODO: on 1.0.0 release, delete this section -->
- `1.0.0` will not be published until the SvelteKit Adapter API is declared stable and SvelteKit is released for general use.
<!-- END -->
Expand Down

0 comments on commit e4b759a

Please sign in to comment.