diff --git a/apps/docs/content/bun/how-to/build-pipeline.mdx b/apps/docs/content/bun/how-to/build-pipeline.mdx
index deacb492..45c29e10 100644
--- a/apps/docs/content/bun/how-to/build-pipeline.mdx
+++ b/apps/docs/content/bun/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your Bun build & deploy pipeline
description: Learn more about how you can configure your node.js service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -97,9 +98,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for Bun builds:
@@ -151,9 +152,9 @@ To customise your build environment use the [prepareCommands](bun/how-to/build-p
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -175,9 +176,9 @@ The os version is fixed and cannot be customised.
Changing the OS setting will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for details about cache behavior.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the build environment by installing additional dependencies or tools to the base build environment.
+Customises the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -225,9 +226,9 @@ If any command fails, it returns an exit code other than 0 and the build is canc
You can configure your prepare commands to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### buildCommands
+### buildCommands
-_REQUIRED._ Defines build commands.
+Defines build commands.
```yml
zerops:
@@ -286,9 +287,9 @@ buildCommands:
If the command ends successfully, it returns the exit code 0 and Zerops triggers the following command. When all `buildCommands` are finished, the application build is completed and ready for the deploy phase.
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -389,9 +390,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -405,9 +406,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -433,9 +434,9 @@ Read more about [environment variables](bun/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current Bun version for your runtime.
Following options are available for Bun runtimes:
@@ -494,9 +495,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customise your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -514,9 +515,9 @@ We are currently using following os version:
The os version is fixed and cannot be customised.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
Projects in Zerops represent a group of one or more services. Services can be of different types (runtime services, databases, message brokers, object storage, etc.). All services of the same project share a **dedicated private network**. To connect to a service within the same project, just use the service hostname and its internal port.
@@ -530,9 +531,9 @@ Each port has following attributes:
| protocol | **Optional.** Defines the protocol. Allowed values are `TCP` or `UDP`. Default value is `TCP`. |
| httpSupport | **Optional.** `httpSupport = true` is the default setting for TCP protocol. Set `httpSupport = false` if a web server isn't running on the port. Zerops uses this information for the configuration of [public access](/features/access). `httpSupport = true` is available only in combination with the TCP protocol. |
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the Bun runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customises the Bun runtime environment by installing additional dependencies or tools to the runtime base environment.
The base Bun environment contains {data.alpine.default} the selected
@@ -615,9 +616,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -653,9 +654,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -676,9 +677,9 @@ zerops:
Read more about [environment variables](bun/how-to/env-variables) in Zerops.
-### start
+### start
-_REQUIRED._ Defines the start command for your Bun application.
+Defines the start command for your Bun application.
```yml
zerops:
@@ -695,9 +696,9 @@ zerops:
We recommend starting your Bun application using `bun start`.
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -772,9 +773,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -796,9 +797,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](bun/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](bun/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/bun/how-to/build-process.mdx b/apps/docs/content/bun/how-to/build-process.mdx
index be092696..0c2b8e0e 100644
--- a/apps/docs/content/bun/how-to/build-process.mdx
+++ b/apps/docs/content/bun/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about node.js' build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
- 
@@ -37,11 +38,11 @@ The build container is automatically deleted after the build has finished or fai
When you know that the running build is not correct and you want to cancel it, you can do it in Zerops GUI. Go to the service detail, open the list of running processes and click on the **Open pipeline detail** button. Then click on the **Cancel build** button.
- 
diff --git a/apps/docs/content/bun/how-to/customize-runtime.mdx b/apps/docs/content/bun/how-to/customize-runtime.mdx
index fe0905f3..d045cd70 100644
--- a/apps/docs/content/bun/how-to/customize-runtime.mdx
+++ b/apps/docs/content/bun/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customise Bun runtime environment
description: Learn how you can customise your node.js runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
- 
diff --git a/apps/docs/content/bun/how-to/deploy-process.mdx b/apps/docs/content/bun/how-to/deploy-process.mdx
index 712030c3..770c0a35 100644
--- a/apps/docs/content/bun/how-to/deploy-process.mdx
+++ b/apps/docs/content/bun/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Bun Deploy process
description: More about how node.js deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
- 
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
- 
diff --git a/apps/docs/content/bun/how-to/env-variables.mdx b/apps/docs/content/bun/how-to/env-variables.mdx
index 042988a9..222cf1ba 100644
--- a/apps/docs/content/bun/how-to/env-variables.mdx
+++ b/apps/docs/content/bun/how-to/env-variables.mdx
@@ -115,11 +115,32 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/deno/how-to/build-pipeline.mdx b/apps/docs/content/deno/how-to/build-pipeline.mdx
index eefb5e51..edfbfeda 100644
--- a/apps/docs/content/deno/how-to/build-pipeline.mdx
+++ b/apps/docs/content/deno/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your Deno build & deploy pipeline
description: Learn more about how you can configure your deno service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -94,9 +95,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for Deno builds:
@@ -146,9 +147,9 @@ To customise your build environment use the [prepareCommands](/deno/how-to/build
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -170,9 +171,9 @@ The os version is fixed and cannot be customised.
Changing the OS setting will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for details about cache behavior.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the build environment by installing additional dependencies or tools to the base build environment.
+Customises the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -220,9 +221,9 @@ If any command fails, it returns an exit code other than 0 and the build is canc
You can configure your prepare commands to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### buildCommands
+### buildCommands
-_REQUIRED._ Defines build commands.
+Defines build commands.
```yml
zerops:
@@ -279,9 +280,9 @@ buildCommands:
If the command ends successfully, it returns the exit code 0 and Zerops triggers the following command. When all `buildCommands` are finished, the application build is completed and ready for the deploy phase.
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -382,9 +383,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -398,9 +399,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -426,9 +427,9 @@ Read more about [environment variables](/deno/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current Deno version for your runtime.
Following options are available for Deno builds:
@@ -487,9 +488,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customise your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -507,9 +508,9 @@ We are currently using following os version:
The os version is fixed and cannot be customised.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
Projects in Zerops represent a group of one or more services. Services can be of different types (runtime services, databases, message brokers, object storage, etc.). All services of the same project share a **dedicated private network**. To connect to a service within the same project, just use the service hostname and its internal port.
@@ -523,9 +524,9 @@ Each port has following attributes:
| protocol | **Optional.** Defines the protocol. Allowed values are `TCP` or `UDP`. Default value is `TCP`. |
| httpSupport | **Optional.** `httpSupport = true` is the default setting for TCP protocol. Set `httpSupport = false` if a web server isn't running on the port. Zerops uses this information for the configuration of [public access](/features/access). `httpSupport = true` is available only in combination with the TCP protocol. |
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the Deno runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customises the Deno runtime environment by installing additional dependencies or tools to the runtime base environment.
The base Deno environment contains {data.alpine.default} the selected
@@ -608,9 +609,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -646,9 +647,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -669,9 +670,9 @@ zerops:
Read more about [environment variables](/deno/how-to/env-variables) in Zerops.
-### start
+### start
-_REQUIRED._ Defines the start command for your Deno application.
+Defines the start command for your Deno application.
```yml
zerops:
@@ -688,9 +689,9 @@ zerops:
We recommend starting your Deno application using `deno task start`.
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -765,9 +766,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -789,9 +790,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/deno/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/deno/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/deno/how-to/build-process.mdx b/apps/docs/content/deno/how-to/build-process.mdx
index 6e5c2c78..29d499b1 100644
--- a/apps/docs/content/deno/how-to/build-process.mdx
+++ b/apps/docs/content/deno/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about deno' build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
-
@@ -37,11 +38,11 @@ The build container is automatically deleted after the build has finished or fai
When you know that the running build is not correct and you want to cancel it, you can do it in Zerops GUI. Go to the service detail, open the list of running processes and click on the **Open pipeline detail** button. Then click on the **Cancel build** button.
-
diff --git a/apps/docs/content/deno/how-to/customize-runtime.mdx b/apps/docs/content/deno/how-to/customize-runtime.mdx
index b016f816..1b059a3c 100644
--- a/apps/docs/content/deno/how-to/customize-runtime.mdx
+++ b/apps/docs/content/deno/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customise Deno runtime environment
description: Learn how you can customise your deno runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/deno/how-to/deploy-process.mdx b/apps/docs/content/deno/how-to/deploy-process.mdx
index 863d658d..7e980d49 100644
--- a/apps/docs/content/deno/how-to/deploy-process.mdx
+++ b/apps/docs/content/deno/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Deno Deploy process
description: More about how deno deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/deno/how-to/env-variables.mdx b/apps/docs/content/deno/how-to/env-variables.mdx
index 95f96631..c2ea4219 100644
--- a/apps/docs/content/deno/how-to/env-variables.mdx
+++ b/apps/docs/content/deno/how-to/env-variables.mdx
@@ -115,11 +115,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/dotnet/how-to/build-pipeline.mdx b/apps/docs/content/dotnet/how-to/build-pipeline.mdx
index bc76b852..8e6151c1 100644
--- a/apps/docs/content/dotnet/how-to/build-pipeline.mdx
+++ b/apps/docs/content/dotnet/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your .NET build & deploy pipeline
description: Learn more about how you can configure your dotnet service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import Image from '/src/components/Image';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -98,9 +99,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for .NET builds:
@@ -150,9 +151,9 @@ To customize your build environment use the [prepareCommands](/dotnet/how-to/bui
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -174,9 +175,9 @@ The os version is fixed and cannot be customized.
Changing the OS setting will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for details about cache behavior.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customizes the build environment by installing additional dependencies or tools to the base build environment.
+Customizes the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -224,9 +225,9 @@ If any command fails, it returns an exit code other than 0 and the build is canc
You can configure your prepare commands to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### buildCommands
+### buildCommands
-_REQUIRED._ Defines build commands.
+Defines build commands.
```yml
zerops:
@@ -283,9 +284,9 @@ buildCommands:
If the command ends successfully, it returns the exit code 0 and Zerops triggers the following command. When all `buildCommands` are finished, the application build is completed and ready for the deploy phase.
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -384,9 +385,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -400,9 +401,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -428,9 +429,9 @@ Read more about [environment variables](/dotnet/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current .NET version for your runtime.
Following options are available for .NET builds:
@@ -489,9 +490,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customise your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -509,9 +510,9 @@ We are currently using following os version:
The os version is fixed and cannot be customised.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
Projects in Zerops represent a group of one or more services. Services can be of different types (runtime services, databases, message brokers, object storage, etc.). All services of the same project share a **dedicated private network**. To connect to a service within the same project, just use the service hostname and its internal port.
@@ -543,9 +544,9 @@ Each port has following attributes:
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the .NET runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customises the .NET runtime environment by installing additional dependencies or tools to the runtime base environment.
The base .NET environment contains {data.alpine.default}, the selected
@@ -630,9 +631,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -668,9 +669,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -691,9 +692,9 @@ zerops:
Read more about [environment variables](/dotnet/how-to/env-variables) in Zerops.
-### start
+### start
-_REQUIRED._ Defines the start command for your .NET application.
+Defines the start command for your .NET application.
```yml
zerops:
@@ -708,9 +709,9 @@ zerops:
start: cd app && dotnet dnet.dll
```
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -800,9 +801,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -824,9 +825,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/dotnet/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/dotnet/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/dotnet/how-to/env-variables.mdx b/apps/docs/content/dotnet/how-to/env-variables.mdx
index 85ff53c9..59009c88 100644
--- a/apps/docs/content/dotnet/how-to/env-variables.mdx
+++ b/apps/docs/content/dotnet/how-to/env-variables.mdx
@@ -136,11 +136,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/elixir/how-to/build-pipeline.mdx b/apps/docs/content/elixir/how-to/build-pipeline.mdx
index adf89714..caf59615 100644
--- a/apps/docs/content/elixir/how-to/build-pipeline.mdx
+++ b/apps/docs/content/elixir/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your Elixir build & deploy pipeline
description: Learn more about how you can configure your Elixir service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -95,9 +96,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for Elixir builds:
@@ -147,9 +148,9 @@ To customise your build environment use the [prepareCommands](/elixir/how-to/bui
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -171,9 +172,9 @@ The os version is fixed and cannot be customised.
Changing the OS setting will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for details about cache behavior.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the build environment by installing additional dependencies or tools to the base build environment.
+Customises the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -221,9 +222,9 @@ If any command fails, it returns an exit code other than 0 and the build is canc
You can configure your prepare commands to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### buildCommands
+### buildCommands
-_REQUIRED._ Defines build commands.
+Defines build commands.
```yml
zerops:
@@ -282,9 +283,9 @@ buildCommands:
If the command ends successfully, it returns the exit code 0 and Zerops triggers the following command. When all `buildCommands` are finished, the application build is completed and ready for the deploy phase.
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -385,9 +386,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -401,9 +402,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -429,9 +430,9 @@ Read more about [environment variables](/elixir/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current Elixir version for your runtime.
Following options are available for Elixir builds:
@@ -490,9 +491,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customise your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -510,9 +511,9 @@ We are currently using following os version:
The os version is fixed and cannot be customised.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
Projects in Zerops represent a group of one or more services. Services can be of different types (runtime services, databases, message brokers, object storage, etc.). All services of the same project share a **dedicated private network**. To connect to a service within the same project, just use the service hostname and its internal port.
@@ -526,9 +527,9 @@ Each port has following attributes:
| protocol | **Optional.** Defines the protocol. Allowed values are `TCP` or `UDP`. Default value is `TCP`. |
| httpSupport | **Optional.** `httpSupport = true` is the default setting for TCP protocol. Set `httpSupport = false` if a web server isn't running on the port. Zerops uses this information for the configuration of [public access](/features/access). `httpSupport = true` is available only in combination with the TCP protocol. |
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the Elixir runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customises the Elixir runtime environment by installing additional dependencies or tools to the runtime base environment.
The base Elixir environment contains {data.alpine.default} the selected
@@ -611,9 +612,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -649,9 +650,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -672,9 +673,9 @@ zerops:
Read more about [environment variables](/elixir/how-to/env-variables) in Zerops.
-### start
+### start
-_REQUIRED._ Defines the start command for your Elixir application.
+Defines the start command for your Elixir application.
```yml
zerops:
@@ -691,9 +692,9 @@ zerops:
We recommend starting your Elixir application using `npm start`.
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -768,9 +769,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -792,9 +793,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/elixir/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/elixir/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/elixir/how-to/build-process.mdx b/apps/docs/content/elixir/how-to/build-process.mdx
index 1389bd7b..dd7d01b9 100644
--- a/apps/docs/content/elixir/how-to/build-process.mdx
+++ b/apps/docs/content/elixir/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about Elixir' build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
-
@@ -37,11 +38,11 @@ The build container is automatically deleted after the build has finished or fai
When you know that the running build is not correct and you want to cancel it, you can do it in Zerops GUI. Go to the service detail, open the list of running processes and click on the **Open pipeline detail** button. Then click on the **Cancel build** button.
-
diff --git a/apps/docs/content/elixir/how-to/customize-runtime.mdx b/apps/docs/content/elixir/how-to/customize-runtime.mdx
index 822c3152..a3b90059 100644
--- a/apps/docs/content/elixir/how-to/customize-runtime.mdx
+++ b/apps/docs/content/elixir/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customise Elixir runtime environment
description: Learn how you can customise your Elixir runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/elixir/how-to/deploy-process.mdx b/apps/docs/content/elixir/how-to/deploy-process.mdx
index 9050241b..48b985e6 100644
--- a/apps/docs/content/elixir/how-to/deploy-process.mdx
+++ b/apps/docs/content/elixir/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Elixir Deploy process
description: More about how Elixir deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/elixir/how-to/env-variables.mdx b/apps/docs/content/elixir/how-to/env-variables.mdx
index f2858e23..bd4c5b3e 100644
--- a/apps/docs/content/elixir/how-to/env-variables.mdx
+++ b/apps/docs/content/elixir/how-to/env-variables.mdx
@@ -115,11 +115,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/features/pipeline.mdx b/apps/docs/content/features/pipeline.mdx
index 110998e0..79a3f0ca 100644
--- a/apps/docs/content/features/pipeline.mdx
+++ b/apps/docs/content/features/pipeline.mdx
@@ -349,7 +349,7 @@ When you know that the running build is not correct and you want to cancel it, y
lightImage="/img/gui/running-build.webp"
darkImage="/img/gui/running-build.webp"
alt="Running build"
- style={{ width: '100%%', height: 'auto' }}
+ style={{ width: '100%', height: 'auto' }}
/>
diff --git a/apps/docs/content/gleam/how-to/build-pipeline.mdx b/apps/docs/content/gleam/how-to/build-pipeline.mdx
index 7d3862cb..d03c3422 100644
--- a/apps/docs/content/gleam/how-to/build-pipeline.mdx
+++ b/apps/docs/content/gleam/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your Gleam build & deploy pipeline
description: Learn more about how you can configure your Gleam service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -96,9 +97,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for Gleam builds:
@@ -148,9 +149,9 @@ To customise your build environment use the [prepareCommands](/gleam/how-to/buil
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -172,9 +173,9 @@ The os version is fixed and cannot be customised.
Changing the OS setting will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for details about cache behavior.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the build environment by installing additional dependencies or tools to the base build environment.
+Customises the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -222,9 +223,9 @@ If any command fails, it returns an exit code other than 0 and the build is canc
You can configure your prepare commands to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### buildCommands
+### buildCommands
-_REQUIRED._ Defines build commands.
+Defines build commands.
```yml
zerops:
@@ -283,9 +284,9 @@ buildCommands:
If the command ends successfully, it returns the exit code 0 and Zerops triggers the following command. When all `buildCommands` are finished, the application build is completed and ready for the deploy phase.
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -386,9 +387,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -402,9 +403,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -430,9 +431,9 @@ Read more about [environment variables](/gleam/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current Gleam version for your runtime.
Following options are available for Gleam runtimes:
@@ -491,9 +492,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customise your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -511,9 +512,9 @@ We are currently using following os version:
The os version is fixed and cannot be customised.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
Projects in Zerops represent a group of one or more services. Services can be of different types (runtime services, databases, message brokers, object storage, etc.). All services of the same project share a **dedicated private network**. To connect to a service within the same project, just use the service hostname and its internal port.
@@ -527,9 +528,9 @@ Each port has following attributes:
| protocol | **Optional.** Defines the protocol. Allowed values are `TCP` or `UDP`. Default value is `TCP`. |
| httpSupport | **Optional.** `httpSupport = true` is the default setting for TCP protocol. Set `httpSupport = false` if a web server isn't running on the port. Zerops uses this information for the configuration of [public access](/features/access). `httpSupport = true` is available only in combination with the TCP protocol. |
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the Gleam runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customises the Gleam runtime environment by installing additional dependencies or tools to the runtime base environment.
The base Gleam environment contains {data.alpine.default} the selected
@@ -612,9 +613,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -650,9 +651,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -673,9 +674,9 @@ zerops:
Read more about [environment variables](/gleam/how-to/env-variables) in Zerops.
-### start
+### start
-_REQUIRED._ Defines the start command for your Gleam application.
+Defines the start command for your Gleam application.
```yml
zerops:
@@ -692,9 +693,9 @@ zerops:
We recommend starting your Gleam application using `npm start`.
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -769,9 +770,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -793,9 +794,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/gleam/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/gleam/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/gleam/how-to/build-process.mdx b/apps/docs/content/gleam/how-to/build-process.mdx
index 83b8cb75..a2026581 100644
--- a/apps/docs/content/gleam/how-to/build-process.mdx
+++ b/apps/docs/content/gleam/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about Gleam' build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
-
@@ -37,11 +38,11 @@ The build container is automatically deleted after the build has finished or fai
When you know that the running build is not correct and you want to cancel it, you can do it in Zerops GUI. Go to the service detail, open the list of running processes and click on the **Open pipeline detail** button. Then click on the **Cancel build** button.
-
diff --git a/apps/docs/content/gleam/how-to/customize-runtime.mdx b/apps/docs/content/gleam/how-to/customize-runtime.mdx
index dc46a23f..d9b7dd8f 100644
--- a/apps/docs/content/gleam/how-to/customize-runtime.mdx
+++ b/apps/docs/content/gleam/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customise Gleam runtime environment
description: Learn how you can customise your Gleam runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/gleam/how-to/deploy-process.mdx b/apps/docs/content/gleam/how-to/deploy-process.mdx
index d29e8239..c4297bf0 100644
--- a/apps/docs/content/gleam/how-to/deploy-process.mdx
+++ b/apps/docs/content/gleam/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Gleam Deploy process
description: More about how Gleam deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/gleam/how-to/env-variables.mdx b/apps/docs/content/gleam/how-to/env-variables.mdx
index 7fa9f454..4def0e9c 100644
--- a/apps/docs/content/gleam/how-to/env-variables.mdx
+++ b/apps/docs/content/gleam/how-to/env-variables.mdx
@@ -115,11 +115,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/go/how-to/build-pipeline.mdx b/apps/docs/content/go/how-to/build-pipeline.mdx
index cb1bb187..66d62f83 100644
--- a/apps/docs/content/go/how-to/build-pipeline.mdx
+++ b/apps/docs/content/go/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your Go build & deploy pipeline
description: Learn more about how you can configure your go application's build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -92,9 +93,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for Go builds:
@@ -144,9 +145,9 @@ To customize your build environment use the [prepareCommands](/go/how-to/build-p
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -168,9 +169,9 @@ The os version is fixed and cannot be customized.
Changing the OS setting will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for details about cache behavior.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customizes the build environment by installing additional dependencies or tools to the base build environment.
+Customizes the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -218,9 +219,9 @@ If any command fails, it returns an exit code other than 0 and the build is canc
You can configure your prepare commands to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### buildCommands
+### buildCommands
-_REQUIRED._ Defines build commands.
+Defines build commands.
```yml
zerops:
@@ -277,9 +278,9 @@ buildCommands:
If the command ends successfully, it returns the exit code 0 and Zerops triggers the following command. When all `buildCommands` are finished, the application build is completed and ready for the deploy phase.
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -378,9 +379,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -394,9 +395,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -422,9 +423,9 @@ Read more about [environment variables](/go/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current Go version for your runtime.
Following options are available for Go builds:
@@ -483,9 +484,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customise your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -503,9 +504,9 @@ We are currently using following os version:
The os version is fixed and cannot be customised.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
Projects in Zerops represent a group of one or more services. Services can be of different types (runtime services, databases, message brokers, object storage, etc.). All services of the same project share a **dedicated private network**. To connect to a service within the same project, just use the service hostname and its internal port.
@@ -538,9 +539,9 @@ Each port has following attributes:
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the Go runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customises the Go runtime environment by installing additional dependencies or tools to the runtime base environment.
The base Go environment contains {data.alpine.default}, the selected
@@ -622,9 +623,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -660,9 +661,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -683,9 +684,9 @@ zerops:
Read more about [environment variables](/go/how-to/env-variables) in Zerops.
-### start
+### start
-_REQUIRED._ Defines the start command for your Go application.
+Defines the start command for your Go application.
```yml
zerops:
@@ -702,9 +703,9 @@ zerops:
We recommend starting your Go application using `./app`.
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -795,9 +796,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -819,9 +820,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/go/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/go/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/go/how-to/build-process.mdx b/apps/docs/content/go/how-to/build-process.mdx
index 40f6d9c0..910c581d 100644
--- a/apps/docs/content/go/how-to/build-process.mdx
+++ b/apps/docs/content/go/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about go's build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
-
diff --git a/apps/docs/content/go/how-to/customize-runtime.mdx b/apps/docs/content/go/how-to/customize-runtime.mdx
index 5301b09a..851d3b96 100644
--- a/apps/docs/content/go/how-to/customize-runtime.mdx
+++ b/apps/docs/content/go/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customize Go runtime environment
description: Learn how you can customize your go runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/go/how-to/deploy-process.mdx b/apps/docs/content/go/how-to/deploy-process.mdx
index 7c8fe098..32d6b8cd 100644
--- a/apps/docs/content/go/how-to/deploy-process.mdx
+++ b/apps/docs/content/go/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Go Deploy process
description: More about how go deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/go/how-to/env-variables.mdx b/apps/docs/content/go/how-to/env-variables.mdx
index 755883b4..76701caf 100644
--- a/apps/docs/content/go/how-to/env-variables.mdx
+++ b/apps/docs/content/go/how-to/env-variables.mdx
@@ -135,11 +135,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/help/faq.mdx b/apps/docs/content/help/faq.mdx
index b671da13..4a218b10 100644
--- a/apps/docs/content/help/faq.mdx
+++ b/apps/docs/content/help/faq.mdx
@@ -16,20 +16,22 @@ Get quick answers to your related questions about Zerops from frequently asked q
You can access the Zerops Dashboard GUI directly at app.zerops.io.
- It's free to get started, and no credit card is required! However, we
- recommend visiting our pricing page to explore the options that best suit your needs.
+ You get $15 free credit to get started. No credit card is required! However, we recommend using our [pricing calculator](/features/pricing#pricing-calculator) to calculate your monthly costs.
- Navigate to the main menu in the Zerop GUI (with your icon) and add a new user with the selected email to your team.
+ Navigate to the main menu in the Zerops GUI (with your icon) and add a new user with the selected email to your team.
You can reach us on our Discord server for support. For additional contact options, please visit our contacts page.
+
+ You can reach us on our Discord server for support. For additional contact options, please visit our contacts page.
+
diff --git a/apps/docs/content/java/how-to/build-pipeline.mdx b/apps/docs/content/java/how-to/build-pipeline.mdx
index 8c39654d..2cc3c4b2 100644
--- a/apps/docs/content/java/how-to/build-pipeline.mdx
+++ b/apps/docs/content/java/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your Java build & deploy pipeline
description: Learn more about how you can configure your java service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedList from '@site/src/components/UnorderedList';
@@ -91,9 +92,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for Java builds:
@@ -144,9 +145,9 @@ To customize your build environment use the [prepareCommands](/java/how-to/build
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -168,9 +169,9 @@ The os version is fixed and cannot be customized.
Changing the OS setting will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for details about cache behavior.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customizes the build environment by installing additional dependencies or tools to the base build environment.
+Customizes the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -218,9 +219,9 @@ If any command fails, it returns an exit code other than 0 and the build is canc
You can configure your prepare commands to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### buildCommands
+### buildCommands
-_REQUIRED._ Defines build commands.
+Defines build commands.
```yml
zerops:
@@ -277,9 +278,9 @@ buildCommands:
If the command ends successfully, it returns the exit code 0 and Zerops triggers the following command. When all `buildCommands` are finished, the application build is completed and ready for the deploy phase.
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -378,9 +379,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -394,9 +395,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -421,9 +422,9 @@ Read more about [environment variables](/java/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current Java version for your runtime.
Following options are available for Java builds:
@@ -482,9 +483,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customize your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -502,9 +503,9 @@ We are currently using following os version:
The os version is fixed and cannot be customized.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
Projects in Zerops represent a group of one or more services. Services can be of different types (runtime services, databases, message brokers, object storage, etc.). All services of the same project share a **dedicated private network**. To connect to a service within the same project, just use the service hostname and its internal port.
@@ -537,9 +538,9 @@ Each port has following attributes:
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customizes the Java runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customizes the Java runtime environment by installing additional dependencies or tools to the runtime base environment.
The base Java environment contains {data.alpine.default}, the selected major
@@ -623,9 +624,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -661,9 +662,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -683,9 +684,9 @@ zerops:
Read more about [environment variables](/java/how-to/env-variables) in Zerops.
-### start
+### start
-_REQUIRED._ Defines the start command for your Java application.
+Defines the start command for your Java application.
```yml
zerops:
@@ -702,9 +703,9 @@ zerops:
We recommend starting your Java application using `java -jar target/app.jar`.
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -794,9 +795,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -818,9 +819,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/java/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/java/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/java/how-to/build-process.mdx b/apps/docs/content/java/how-to/build-process.mdx
index f1504625..a57f9e6e 100644
--- a/apps/docs/content/java/how-to/build-process.mdx
+++ b/apps/docs/content/java/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about java's build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
-
diff --git a/apps/docs/content/java/how-to/customize-runtime.mdx b/apps/docs/content/java/how-to/customize-runtime.mdx
index ce1dff95..a45c933b 100644
--- a/apps/docs/content/java/how-to/customize-runtime.mdx
+++ b/apps/docs/content/java/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customize Java runtime environment
description: Learn how you can customize your java runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/java/how-to/deploy-process.mdx b/apps/docs/content/java/how-to/deploy-process.mdx
index b83f40e4..6830254b 100644
--- a/apps/docs/content/java/how-to/deploy-process.mdx
+++ b/apps/docs/content/java/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Java Deploy process
description: More about how java deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/java/how-to/env-variables.mdx b/apps/docs/content/java/how-to/env-variables.mdx
index 21856739..4742fd24 100644
--- a/apps/docs/content/java/how-to/env-variables.mdx
+++ b/apps/docs/content/java/how-to/env-variables.mdx
@@ -135,11 +135,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/nginx/how-to/build-pipeline.mdx b/apps/docs/content/nginx/how-to/build-pipeline.mdx
index 5cfce5ca..a786bb59 100644
--- a/apps/docs/content/nginx/how-to/build-pipeline.mdx
+++ b/apps/docs/content/nginx/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your Nginx build & deploy pipeline
description: Learn more about how you can configure your nginx service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -114,9 +115,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current Nginx version for your runtime.
Following options are available for Nginx builds:
@@ -175,9 +176,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customize your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -195,9 +196,9 @@ We are currently using following os version:
The os version is fixed and cannot be customized.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
:::info
If no ports are specified, Zerops adds the port TCP 80 automatically.
@@ -240,9 +241,9 @@ Each port has following attributes:
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customizes the Nginx runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customizes the Nginx runtime environment by installing additional dependencies or tools to the runtime base environment.
The base Nginx environment contains {data.alpine.default}, the selected
@@ -332,9 +333,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -370,9 +371,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances.
-### documentRoot
+### documentRoot
-_OPTIONAL._ Customizes the folder that will be used as the root of the publicly accessible web server content.
+Customizes the folder that will be used as the root of the publicly accessible web server content.
:::info
By default, the document root is configured to `/var/www`.
@@ -395,9 +396,9 @@ zerops:
documentRoot: public
```
-### siteConfigPath
+### siteConfigPath
-_OPTIONAL._ Sets the custom Nginx configuration.
+Sets the custom Nginx configuration.
:::info
If you don't set your custom configuration Zerops applies the [default](/nginx/how-to/customize-web-server#default-nginx-configuration) configuration.
@@ -406,9 +407,9 @@ If you don't set your custom configuration Zerops applies the [default](/nginx/h
The file must be deployed in the runtime container. Enter the path to the file relative to the `/var/www` folder.
Read more about the [web server customization](/nginx/how-to/customize-web-server).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -428,9 +429,9 @@ zerops:
Read more about [environment variables](/nginx/how-to/env-variables) in Zerops.
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -524,9 +525,9 @@ Read more about how the [health check works] in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/nginx/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/nginx/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/nginx/how-to/customize-runtime.mdx b/apps/docs/content/nginx/how-to/customize-runtime.mdx
index a5e1b502..688c1e86 100644
--- a/apps/docs/content/nginx/how-to/customize-runtime.mdx
+++ b/apps/docs/content/nginx/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customize Nginx Static runtime environment
description: Learn how you can customize your nginx static runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/nginx/how-to/deploy-process.mdx b/apps/docs/content/nginx/how-to/deploy-process.mdx
index 35a54cc9..45afd3af 100644
--- a/apps/docs/content/nginx/how-to/deploy-process.mdx
+++ b/apps/docs/content/nginx/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Nginx Deploy process
description: More about how nginx deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -82,11 +84,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/nginx/how-to/env-variables.mdx b/apps/docs/content/nginx/how-to/env-variables.mdx
index a6d396ec..13191082 100644
--- a/apps/docs/content/nginx/how-to/env-variables.mdx
+++ b/apps/docs/content/nginx/how-to/env-variables.mdx
@@ -135,11 +135,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/nodejs/how-to/build-process.mdx b/apps/docs/content/nodejs/how-to/build-process.mdx
index 30585ec4..4c9d4cd2 100644
--- a/apps/docs/content/nodejs/how-to/build-process.mdx
+++ b/apps/docs/content/nodejs/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about node.js' build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
-
@@ -53,11 +54,11 @@ The build container is automatically deleted after the build has finished or fai
When you know that the running build is not correct and you want to cancel it, you can do it in Zerops GUI. Go to the service detail, open the list of running processes and click on the **Open pipeline detail** button. Then click on the **Cancel build** button.
-
diff --git a/apps/docs/content/nodejs/how-to/customize-runtime.mdx b/apps/docs/content/nodejs/how-to/customize-runtime.mdx
index 244ca7b1..3bb4c75d 100644
--- a/apps/docs/content/nodejs/how-to/customize-runtime.mdx
+++ b/apps/docs/content/nodejs/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customize Node.js runtime environment
description: Learn how you can customize your node.js runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/nodejs/how-to/deploy-process.mdx b/apps/docs/content/nodejs/how-to/deploy-process.mdx
index 5f47d7c0..da38c477 100644
--- a/apps/docs/content/nodejs/how-to/deploy-process.mdx
+++ b/apps/docs/content/nodejs/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Node.js Deploy process
description: More about how node.js deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/nodejs/how-to/env-variables.mdx b/apps/docs/content/nodejs/how-to/env-variables.mdx
index 9533838e..ea4dfd66 100644
--- a/apps/docs/content/nodejs/how-to/env-variables.mdx
+++ b/apps/docs/content/nodejs/how-to/env-variables.mdx
@@ -136,11 +136,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/php/how-to/build-pipeline.mdx b/apps/docs/content/php/how-to/build-pipeline.mdx
index 86aad20a..d22069ed 100644
--- a/apps/docs/content/php/how-to/build-pipeline.mdx
+++ b/apps/docs/content/php/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your PHP build & deploy pipeline
description: Learn more about how you can configure your php service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -95,9 +96,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for PHP builds:
@@ -147,9 +148,9 @@ To customise your build environment use the [prepareCommands](/php/how-to/build-
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -171,9 +172,9 @@ The os version is fixed and cannot be customised.
Changing the OS setting will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for details about cache behavior.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the build environment by installing additional dependencies or tools to the base build environment.
+Customises the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -221,9 +222,9 @@ If any command fails, it returns an exit code other than 0 and the build is canc
You can configure your prepare commands to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### buildCommands
+### buildCommands
-_REQUIRED._ Defines build commands.
+Defines build commands.
```yml
zerops:
@@ -280,9 +281,9 @@ buildCommands:
If the command ends successfully, it returns the exit code 0 and Zerops triggers the following command. When all `buildCommands` are finished, the application build is completed and ready for the deploy phase.
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -382,9 +383,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -398,9 +399,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -426,9 +427,9 @@ Read more about [environment variables](/php/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current PHP version for your runtime.
Following options are available for PHP builds:
@@ -488,9 +489,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customise your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -508,9 +509,9 @@ We are currently using following os version:
The os version is fixed and cannot be customised.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
:::info
If no ports are specified, Zerops adds the port TCP 80 automatically.
@@ -553,9 +554,9 @@ Each port has following attributes:
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the PHP runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customises the PHP runtime environment by installing additional dependencies or tools to the runtime base environment.
The base PHP environment contains {data.alpine.default}, the selected
@@ -645,9 +646,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -683,9 +684,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### documentRoot
+### documentRoot
-_OPTIONAL._ Customizes the folder that will be used as the root of the publicly accessible web server content.
+Customizes the folder that will be used as the root of the publicly accessible web server content.
:::info
By default, the document root is configured to `/var/www`.
@@ -708,9 +709,9 @@ zerops:
documentRoot: public
```
-### siteConfigPath
+### siteConfigPath
-_OPTIONAL._ Sets the custom Nginx or Apache configuration.
+Sets the custom Nginx or Apache configuration.
:::info
By default, the default [nginx](/php/how-to/customize-web-server#default-nginx-configuration) or [Apache](/php/how-to/customize-web-server#default-apache-configuration) web server configuration is set.
@@ -719,9 +720,9 @@ By default, the default [nginx](/php/how-to/customize-web-server#default-nginx-c
The file must be deployed in the runtime container. Enter the path to the file relative to the `/var/www` folder.
Read more about the [web server customization](/php/how-to/customize-web-server).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -742,9 +743,9 @@ zerops:
Read more about [environment variables](/php/how-to/env-variables) in Zerops.
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -836,9 +837,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -860,9 +861,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/php/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/php/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/php/how-to/build-process.mdx b/apps/docs/content/php/how-to/build-process.mdx
index 510b3e25..7c3e47e9 100644
--- a/apps/docs/content/php/how-to/build-process.mdx
+++ b/apps/docs/content/php/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about php's build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
-
diff --git a/apps/docs/content/php/how-to/customize-runtime.mdx b/apps/docs/content/php/how-to/customize-runtime.mdx
index 02dc1595..90af2d4c 100644
--- a/apps/docs/content/php/how-to/customize-runtime.mdx
+++ b/apps/docs/content/php/how-to/customize-runtime.mdx
@@ -20,12 +20,14 @@ Additional packages and tools can be installed using [run.prepareCommands](/zero
## Runtime Flow
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/php/how-to/deploy-process.mdx b/apps/docs/content/php/how-to/deploy-process.mdx
index b14b317b..7a1ba2ac 100644
--- a/apps/docs/content/php/how-to/deploy-process.mdx
+++ b/apps/docs/content/php/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: PHP Deploy process
description: More about how php deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/php/how-to/env-variables.mdx b/apps/docs/content/php/how-to/env-variables.mdx
index ffe2288e..118b36dc 100644
--- a/apps/docs/content/php/how-to/env-variables.mdx
+++ b/apps/docs/content/php/how-to/env-variables.mdx
@@ -135,11 +135,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/python/how-to/build-pipeline.mdx b/apps/docs/content/python/how-to/build-pipeline.mdx
index f29a9539..d5c7579b 100644
--- a/apps/docs/content/python/how-to/build-pipeline.mdx
+++ b/apps/docs/content/python/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your Python build & deploy pipeline
description: Learn more about how you can configure your python service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -93,9 +94,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for Python builds:
@@ -145,9 +146,9 @@ To customize your build environment use the [prepareCommands](/python/how-to/bui
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -169,9 +170,9 @@ The os version is fixed and cannot be customized.
Changing the OS setting will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for details about cache behavior.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customizes the build environment by installing additional dependencies or tools to the base build environment.
+Customizes the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -235,9 +236,9 @@ prepareCommands:
- apt install python3-pip # already installed for Python services
```
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -336,9 +337,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -352,9 +353,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -380,9 +381,9 @@ Read more about [environment variables](/python/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current Python version for your runtime.
Following options are available for Python builds:
@@ -441,9 +442,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customize your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -461,9 +462,9 @@ We are currently using following os version:
The os version is fixed and cannot be customised.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
Projects in Zerops represent a group of one or more services. Services can be of different types (runtime services, databases, message brokers, object storage, etc.). All services of the same project share a **dedicated private network**. To connect to a service within the same project, just use the service hostname and its internal port.
@@ -494,9 +495,9 @@ Each port has following attributes:
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the Python runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customises the Python runtime environment by installing additional dependencies or tools to the runtime base environment.
The base Python environment contains {data.alpine.default}, the selected
@@ -578,9 +579,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -616,9 +617,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build:prepareCommands](#preparecommands).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -639,9 +640,9 @@ zerops:
Read more about [environment variables](/python/how-to/env-variables) in Zerops.
-### start
+### start
-_REQUIRED._ Defines the start command for your Python application.
+Defines the start command for your Python application.
```yml
zerops:
@@ -656,9 +657,9 @@ zerops:
start: app.py
```
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -750,9 +751,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -774,9 +775,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/python/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/python/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/python/how-to/build-process.mdx b/apps/docs/content/python/how-to/build-process.mdx
index df59e796..09673387 100644
--- a/apps/docs/content/python/how-to/build-process.mdx
+++ b/apps/docs/content/python/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about python's build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
-
diff --git a/apps/docs/content/python/how-to/customize-runtime.mdx b/apps/docs/content/python/how-to/customize-runtime.mdx
index a755a0d7..6b9700a1 100644
--- a/apps/docs/content/python/how-to/customize-runtime.mdx
+++ b/apps/docs/content/python/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customize Python runtime environment
description: Learn how you can customize your python runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/python/how-to/deploy-process.mdx b/apps/docs/content/python/how-to/deploy-process.mdx
index e7d25f8d..58529448 100644
--- a/apps/docs/content/python/how-to/deploy-process.mdx
+++ b/apps/docs/content/python/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Python Deploy process
description: More about how python deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/python/how-to/env-variables.mdx b/apps/docs/content/python/how-to/env-variables.mdx
index 99ce45a8..2826afb0 100644
--- a/apps/docs/content/python/how-to/env-variables.mdx
+++ b/apps/docs/content/python/how-to/env-variables.mdx
@@ -135,11 +135,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/rust/how-to/build-pipeline.mdx b/apps/docs/content/rust/how-to/build-pipeline.mdx
index a25369f8..c523f5e5 100644
--- a/apps/docs/content/rust/how-to/build-pipeline.mdx
+++ b/apps/docs/content/rust/how-to/build-pipeline.mdx
@@ -3,6 +3,7 @@ title: Configure Your Rust build & deploy pipeline
description: Learn more about how you can configure your rust service for build & deploy pipeline.
---
+import Badge from 'docs/src/components/Badge';
import data from '@site/static/data.json';
import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';
@@ -94,9 +95,9 @@ Each service configuration contains at least two sections: **build** and **run**
## Build pipeline configuration
-### base
+### base
-_REQUIRED._ Sets the base technology for the build environment.
+Sets the base technology for the build environment.
Following options are available for Rust builds:
@@ -146,9 +147,9 @@ To customize your build environment use the [prepareCommands](/rust/how-to/build
Modifying the base technology will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### os
+### os
-_OPTIONAL._ Sets the operating system for the build environment.
+Sets the operating system for the build environment.
Following options are available:
@@ -170,9 +171,9 @@ The os version is fixed and cannot be customized.
Modifying the OS will invalidate your build cache. See our [Build Cache Documentation](/features/build-cache) for more details about cache invalidation.
:::
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customizes the build environment by installing additional dependencies or tools to the base build environment.
+Customizes the build environment by installing additional dependencies or tools to the base build environment.
The base build environment contains:
@@ -219,9 +220,9 @@ If any command fails, it returns an exit code other than 0 and the build is canc
You can configure your prepare commands to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### buildCommands
+### buildCommands
-_REQUIRED._ Defines build commands.
+Defines build commands.
```yml
zerops:
@@ -276,9 +277,9 @@ buildCommands:
If the command ends successfully, it returns the exit code 0 and Zerops triggers the following command. When all `buildCommands` are finished, the application build is completed and ready for the deploy phase.
-### deployFiles
+### deployFiles
-_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
+Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use `.deployignore` file.
```yml
# REQUIRED. Select which files / folders to deploy after
@@ -376,9 +377,9 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:
`.deployignore` file also works with `zcli service deploy` command.
:::
-### cache
+### cache
-_OPTIONAL._ Defines which files or folders will be cached for the next build.
+Defines which files or folders will be cached for the next build.
```yml
# OPTIONAL. Which files / folders you want to cache for the next build.
@@ -392,9 +393,9 @@ The cache attribute supports the [~ wildcard character](#how-to-use-a-wildcard-i
Learn more about the [build cache system](/features/build-cache) in Zerops.
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the build environment.
+Defines the environment variables for the build environment.
Enter one or more env variables in following format:
@@ -420,9 +421,9 @@ Read more about [environment variables](/rust/how-to/env-variables) in Zerops.
## Runtime configuration
-### base
+### base
-_OPTIONAL._ Sets the base technology for the runtime environment.
+Sets the base technology for the runtime environment.
If you don't specify the `run.base` attribute, Zerops keeps the current Rust version for your runtime.
Following options are available for Rust builds:
@@ -482,9 +483,9 @@ See the full list of supported [run base environments](/zerops-yml/base-list).
To customize your build environment use the `prepareCommands` attribute.
-### os
+### os
-_OPTIONAL._ Sets the operating system for the runtime environment.
+Sets the operating system for the runtime environment.
Following options are available:
@@ -502,9 +503,9 @@ We are currently using following os version:
The os version is fixed and cannot be customised.
:::
-### ports
+### ports
-_OPTIONAL._ Specifies one or more internal ports on which your application will listen.
+Specifies one or more internal ports on which your application will listen.
Projects in Zerops represent a group of one or more services. Services can be of different types (runtime services, databases, message brokers, object storage, etc.). All services of the same project share a **dedicated private network**. To connect to a service within the same project, just use the service hostname and its internal port.
@@ -537,9 +538,9 @@ Each port has following attributes:
-### prepareCommands
+### prepareCommands
-_OPTIONAL._ Customises the Rust runtime environment by installing additional dependencies or tools to the runtime base environment.
+Customises the Rust runtime environment by installing additional dependencies or tools to the runtime base environment.
The base Rust environment contains {data.alpine.default}, the selected
@@ -629,9 +630,9 @@ zerops:
In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
-### initCommands
+### initCommands
-_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
+Defines one or more commands to be run each time a new runtime container is started or a container is restarted.
```yml
zerops:
@@ -667,9 +668,9 @@ If any of the `initCommands` fails, it returns an exit code other than 0, but de
You can configure your `initCommands` to be run in a single shell instance or multiple shell instances. The format is identical to [build commands](#buildcommands).
-### envVariables
+### envVariables
-_OPTIONAL._ Defines the environment variables for the runtime environment.
+Defines the environment variables for the runtime environment.
Enter one or more env variables in following format:
@@ -690,9 +691,9 @@ zerops:
Read more about [environment variables](/rust/how-to/env-variables) in Zerops.
-### start
+### start
-_REQUIRED._ Defines the start command for your Rust application.
+Defines the start command for your Rust application.
```yml
zerops:
@@ -707,9 +708,9 @@ zerops:
start: ./app
```
-### health check
+### healthCheck
-_OPTIONAL._ Defines a health check.
+Defines a health check.
`healthCheck` requires either one `httpGet` object or one `exec` object.
@@ -801,9 +802,9 @@ zerops:
Read more about how the [health check works] in Zerops.
-### crontab
+### crontab
-_OPTIONAL._ Defines cron jobs.
+Defines cron jobs.
Setup cron jobs in the following format:
@@ -825,9 +826,9 @@ Read more about setting up [cron](/references/cron) in Zerops.
## Deploy configuration
-### readiness check
+### readinessCheck
-_OPTIONAL._ Defines a readiness check. Read more about how the [readiness check works](/rust/how-to/deploy-process#readiness-checks) in Zerops.
+Defines a readiness check. Read more about how the [readiness check works](/rust/how-to/deploy-process#readiness-checks) in Zerops.
`readinessCheck` requires either one `httpGet` object or one `exec` object.
diff --git a/apps/docs/content/rust/how-to/build-process.mdx b/apps/docs/content/rust/how-to/build-process.mdx
index 4991cceb..40887906 100644
--- a/apps/docs/content/rust/how-to/build-process.mdx
+++ b/apps/docs/content/rust/how-to/build-process.mdx
@@ -4,13 +4,14 @@ description: Learn more about rust's build process.
---
import data from '@site/static/data.json';
+import Image from '/src/components/Image';
-
diff --git a/apps/docs/content/rust/how-to/customize-runtime.mdx b/apps/docs/content/rust/how-to/customize-runtime.mdx
index 8bae3eb2..4a75638a 100644
--- a/apps/docs/content/rust/how-to/customize-runtime.mdx
+++ b/apps/docs/content/rust/how-to/customize-runtime.mdx
@@ -3,12 +3,14 @@ title: Customize Rust runtime environment
description: Learn how you can customize your rust runtime environment on Zerops.
---
+import Image from '/src/components/Image';
+
-
diff --git a/apps/docs/content/rust/how-to/deploy-process.mdx b/apps/docs/content/rust/how-to/deploy-process.mdx
index 70f33c87..85746400 100644
--- a/apps/docs/content/rust/how-to/deploy-process.mdx
+++ b/apps/docs/content/rust/how-to/deploy-process.mdx
@@ -3,12 +3,14 @@ title: Rust Deploy process
description: More about how rust deploy process works on Zerops.
---
+import Image from '/src/components/Image';
+
-
@@ -84,11 +86,11 @@ Zerops keeps 10 last versions of your application in the internal storage.
The list of application versions is available in Zerops GUI. Go to the service detail and choose **Service dashboard & runtime containers** from the left menu. The active version is highlighted, show all archived version by clicking on the button below.
-
diff --git a/apps/docs/content/rust/how-to/env-variables.mdx b/apps/docs/content/rust/how-to/env-variables.mdx
index 1e56dd03..5dfeb80f 100644
--- a/apps/docs/content/rust/how-to/env-variables.mdx
+++ b/apps/docs/content/rust/how-to/env-variables.mdx
@@ -134,11 +134,33 @@ You can reference another variable of the same service using `${key}` in your va
### Reference a local variable in another variable value
-| Variable key | Variable value | Computed variable value |
-| ------------ | ------------------- | ----------------------- |
-| id | 12345 | 12345 |
-| hostname | app | app |
-| name | `${id}-${hostname}` | 12345-app |
+
+
+
+ | Variable key |
+ Variable value |
+ Computed variable value |
+
+
+
+
+ | id |
+ 12345 |
+ 12345 |
+
+
+ | hostname |
+ app |
+ app |
+
+
+ | name |
+ ${'{id}'}-${'{hostname}'} |
+ 12345-app |
+
+
+
+
### Reference a variable of another project service
diff --git a/apps/docs/content/zerops-yml/cron.mdx b/apps/docs/content/zerops-yml/cron.mdx
index 2dfcc751..65dfeeea 100644
--- a/apps/docs/content/zerops-yml/cron.mdx
+++ b/apps/docs/content/zerops-yml/cron.mdx
@@ -3,19 +3,19 @@ title: Cron Jobs & Tasks
description: Learn how to set up automated tasks and scheduled jobs in Zerops
---
+import Badge from 'docs/src/components/Badge';
+
Cron jobs are scheduled commands that execute automatically inside a service's containers based on defined timing rules.
In Zerops, these jobs are configured in the `run` section of `zerops.yml` file under the `crontab` key.
## Parameters
-### command
-*string, REQUIRED*
+### command
The shell command to execute at the scheduled time. This can be any valid command.
-### timing
-*string, REQUIRED*
+### timing
The schedule for when the task should run, specified in standard cron format using five space-separated fields:
- Minute (0–59)
@@ -28,15 +28,13 @@ The schedule for when the task should run, specified in standard cron format usi
- `"0 5 * * *"` – Runs daily at 5:00 AM.
- `"*/10 * * * *"` – Runs every 10 minutes.
-### allContainers
-*boolean, REQUIRED*
+### allContainers
**Options:**
- `true` – Command runs on all containers.
- `false` – Command runs on only one container.
-### workingDir
-*string, REQUIRED*
+### workingDir
Specifies the directory where the command will be executed. If not set, it defaults to `/var/www`.
diff --git a/apps/docs/src/components/Faq/index.tsx b/apps/docs/src/components/Faq/index.tsx
index 19defdf5..916f3e5c 100644
--- a/apps/docs/src/components/Faq/index.tsx
+++ b/apps/docs/src/components/Faq/index.tsx
@@ -12,11 +12,28 @@ export function FAQItem({ question, children }: FAQItemProps) {
const [height, setHeight] = useState(0);
useEffect(() => {
- if (isOpen && answerRef.current) {
- setHeight(answerRef.current.scrollHeight);
- } else {
- setHeight(0);
+ const updateHeight = () => {
+ if (isOpen && answerRef.current) {
+ setHeight(answerRef.current.scrollHeight);
+ } else {
+ setHeight(0);
+ }
+ };
+
+ updateHeight();
+ // Add a small delay to handle image loading
+ const timer = setTimeout(updateHeight, 100);
+
+ // Handle dynamic content changes
+ const resizeObserver = new ResizeObserver(updateHeight);
+ if (answerRef.current) {
+ resizeObserver.observe(answerRef.current);
}
+
+ return () => {
+ clearTimeout(timer);
+ resizeObserver.disconnect();
+ };
}, [isOpen]);
return (
@@ -36,11 +53,11 @@ export function FAQItem({ question, children }: FAQItemProps) {
-
{children}
+
{children}