You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The App Hosting output bundle is a file based specification that allows differen
15
15
16
16
Any framework that can generate a build output in accordance with the App Hosting output bundle can be deployed on App Hosting.
17
17
18
-
The output bundle primarily consists of a bundle.yaml file that sits inside of the .apphosting directory. This bundle.yaml contains all the ways that frameworks can configure App Hosting when users deploy their applications.
18
+
The output bundle primarily consists of a `bundle.yaml` file that sits inside of the `.apphosting` directory. This bundle.yaml contains all the ways that frameworks can configure App Hosting when users deploy their applications.
19
19
20
20
NOTE: App Hosting technically supports all all node applications, but no custom framework features will be enabled without the output bundle.
21
21
@@ -41,7 +41,7 @@ interface OutputBundle {
41
41
42
42
### Version
43
43
44
-
The version represents which output bundle version is currently being used. The current version is v1.
44
+
The `version` represents which output bundle version is currently being used. The current version is v1.
45
45
46
46
### RunConfig
47
47
@@ -68,18 +68,18 @@ interface EnvVarConfig {
68
68
69
69
| Field | Type | Description |
70
70
| ---------- | ------- | - |
71
-
| runCommand | string |Command to start the server (e.g. "node dist/index.js"). Assume this command is run from the root dir of the workspace. This should be the productionized version of the server start command. |
72
-
| environmentVariables|EnvVarConfig[]| Environment variables present in the server execution environment.|
73
-
| concurrency | number | The maximum number of concurrent requests that each server instance can receive.|
74
-
| cpu | number |The number of CPUs used in a single server instance. |
75
-
| memoryMiB | number | The amount of memory available for a server instance.|
76
-
| minInstance | number |The limit on the minimum number of function instances that may coexist at a given time. |
77
-
| MaxInstance | number | The limit on the maximum number of function instances that may coexist at a given time.|
78
-
| EnvVarConfig.variable | string |Name of the environment variable |
79
-
| EnvVarConfig.value | string |Value associated with the environment variable |
80
-
| EnvVarConfig.availability | RUNTIME | Where the variable will be available. For now this will always be RUNTIME |
81
-
82
-
Many of these fields are shared with apphosting.yaml. See the [runConfig reference documentation](https://firebase.google.com/docs/reference/apphosting/rest/v1beta/projects.locations.backends.builds#runconfig) for additional context.
71
+
|`runCommand`|`string`|Command to start the server (e.g. `node dist/index.js`). Assume this command is run from the root dir of the workspace. This should be the productionized version of the server start command. |
72
+
|`environmentVariables`|`EnvVarConfig[]`| Environment variables present in the server execution environment.|
73
+
|`concurrency`|`number`| The maximum number of concurrent requests that each server instance can receive.|
74
+
|`cpu`|`number`|The number of CPUs used in a single server instance. |
75
+
|`memoryMiB`|`number`| The amount of memory available for a server instance.|
76
+
|`minInstance`|`number`|The limit on the minimum number of function instances that may coexist at a given time. |
77
+
|`MaxInstance`|`number`| The limit on the maximum number of function instances that may coexist at a given time.|
78
+
|`EnvVarConfig.variable`|`string`|Name of the environment variable |
79
+
|`EnvVarConfig.value`|`string`|Value associated with the environment variable |
80
+
|`EnvVarConfig.availability`|`RUNTIME`| Where the variable will be available. For now this will always be `RUNTIME`|
81
+
82
+
Many of these fields are shared with `apphosting.yaml`. See the [runConfig reference documentation](https://firebase.google.com/docs/reference/apphosting/rest/v1beta/projects.locations.backends.builds#runconfig) for additional context.
83
83
84
84
### Metadata
85
85
@@ -95,12 +95,12 @@ interface Metadata {
95
95
96
96
| Field | Type | Description |
97
97
| ---------- | ------- | - |
98
-
| adapterPackageName | string |Name of the adapter (this should be the npm package name) |
99
-
| adapterVersion|string | Version of the adapter|
100
-
| framework | string | Name of the framework that is being supported|
101
-
| frameworkVersion | string |Version of the framework that is being supported |
98
+
|`adapterPackageName`|`string`|Name of the adapter (this should be the npm package name) |
99
+
|`adapterVersion`|`string`| Version of the adapter|
100
+
|`framework`|`string`| Name of the framework that is being supported|
101
+
|`frameworkVersion`|`string`|Version of the framework that is being supported |
102
102
103
-
Here is a sample bundle.yaml file putting all this together:
103
+
Here is a sample `bundle.yaml` file putting all this together:
104
104
105
105
```
106
106
> cat .apphosting/bundle.yaml
@@ -128,4 +128,4 @@ metadata:
128
128
129
129
```
130
130
131
-
As long as you have the bundle.yaml in this format, App Hosting will be able to deploy any framework that supports server side rendering.
131
+
As long as you have the `bundle.yaml` in this format, App Hosting will be able to deploy any framework that supports server side rendering.
0 commit comments