From 6461f9ee73133e5d4b0eecdbcbc56cd8d1153cd5 Mon Sep 17 00:00:00 2001 From: Arjun Aditya Date: Tue, 1 Oct 2024 02:32:42 +0530 Subject: [PATCH] use ` instead of --- apps/docs/content/dotnet/how-to/access.mdx | 6 ++--- .../content/dotnet/how-to/build-pipeline.mdx | 12 ++++----- .../content/dotnet/how-to/build-process.mdx | 2 +- apps/docs/content/dotnet/how-to/create.mdx | 16 ++++++------ .../dotnet/how-to/customize-runtime.mdx | 6 ++--- .../content/dotnet/how-to/deploy-process.mdx | 8 +++--- apps/docs/content/dotnet/how-to/logs.mdx | 10 +++---- .../dotnet/how-to/trigger-pipeline.mdx | 8 +++--- apps/docs/content/dotnet/how-to/upgrade.mdx | 4 +-- .../content/dotnet/tutorial/quickstart.mdx | 2 +- .../content/dotnet/tutorial/runtime-sql.mdx | 10 +++---- .../content/dotnet/tutorial/step-by-step.mdx | 4 +-- .../content/elasticsearch/how-to/create.mdx | 8 +++--- apps/docs/content/features/pipeline.mdx | 12 ++++----- apps/docs/content/go/how-to/access.mdx | 6 ++--- .../docs/content/go/how-to/build-pipeline.mdx | 18 ++++++------- apps/docs/content/go/how-to/build-process.mdx | 2 +- apps/docs/content/go/how-to/create.mdx | 8 +++--- .../content/go/how-to/customize-runtime.mdx | 6 ++--- .../docs/content/go/how-to/deploy-process.mdx | 8 +++--- apps/docs/content/go/how-to/logs.mdx | 6 ++--- .../content/go/how-to/trigger-pipeline.mdx | 8 +++--- apps/docs/content/go/how-to/upgrade.mdx | 4 +-- apps/docs/content/go/tutorial/quickstart.mdx | 2 +- apps/docs/content/go/tutorial/runtime-sql.mdx | 10 +++---- .../docs/content/go/tutorial/step-by-step.mdx | 4 +-- apps/docs/content/java/how-to/access.mdx | 6 ++--- .../content/java/how-to/build-pipeline.mdx | 6 ++--- .../content/java/how-to/build-process.mdx | 2 +- apps/docs/content/java/how-to/create.mdx | 8 +++--- .../content/java/how-to/customize-runtime.mdx | 6 ++--- .../content/java/how-to/deploy-process.mdx | 8 +++--- apps/docs/content/java/how-to/logs.mdx | 8 +++--- .../content/java/how-to/trigger-pipeline.mdx | 8 +++--- apps/docs/content/java/how-to/upgrade.mdx | 4 +-- .../docs/content/java/tutorial/quickstart.mdx | 2 +- .../content/java/tutorial/runtime-sql.mdx | 10 +++---- .../content/java/tutorial/step-by-step.mdx | 4 +-- apps/docs/content/keydb/how-to/create.mdx | 12 ++++----- .../content/keydb/tutorial/quickstart.mdx | 2 +- apps/docs/content/mariadb/how-to/create.mdx | 12 ++++----- .../content/mariadb/tutorial/quickstart.mdx | 2 +- apps/docs/content/mongodb/how-to/create.mdx | 12 ++++----- apps/docs/content/nginx/how-to/access.mdx | 6 ++--- .../content/nginx/how-to/build-pipeline.mdx | 6 ++--- apps/docs/content/nginx/how-to/create.mdx | 16 ++++++------ .../nginx/how-to/customize-runtime.mdx | 6 ++--- .../nginx/how-to/customize-web-server.mdx | 10 +++---- .../content/nginx/how-to/deploy-process.mdx | 8 +++--- .../content/nginx/how-to/trigger-pipeline.mdx | 8 +++--- apps/docs/content/nginx/how-to/upgrade.mdx | 2 +- .../content/nginx/tutorial/quickstart.mdx | 2 +- .../content/nginx/tutorial/runtime-sql.mdx | 10 +++---- .../content/nginx/tutorial/step-by-step.mdx | 4 +-- apps/docs/content/nodejs/how-to/access.mdx | 6 ++--- .../content/nodejs/how-to/build-pipeline.mdx | 22 ++++++++-------- .../content/nodejs/how-to/build-process.mdx | 2 +- apps/docs/content/nodejs/how-to/create.mdx | 16 ++++++------ .../nodejs/how-to/customize-runtime.mdx | 6 ++--- .../content/nodejs/how-to/deploy-process.mdx | 8 +++--- apps/docs/content/nodejs/how-to/logs.mdx | 8 +++--- .../nodejs/how-to/trigger-pipeline.mdx | 8 +++--- apps/docs/content/nodejs/how-to/upgrade.mdx | 4 +-- .../content/nodejs/tutorial/quickstart.mdx | 2 +- .../content/nodejs/tutorial/runtime-sql.mdx | 10 +++---- .../content/nodejs/tutorial/step-by-step.mdx | 4 +-- .../content/object-storage/how-to/create.mdx | 10 +++---- .../object-storage/how-to/update-bucket.mdx | 8 +++--- apps/docs/content/php/how-to/access.mdx | 6 ++--- .../content/php/how-to/build-pipeline.mdx | 14 +++++----- .../docs/content/php/how-to/build-process.mdx | 2 +- apps/docs/content/php/how-to/create.mdx | 26 +++++++++---------- .../content/php/how-to/customize-runtime.mdx | 6 ++--- .../php/how-to/customize-web-server.mdx | 20 +++++++------- .../content/php/how-to/deploy-process.mdx | 8 +++--- apps/docs/content/php/how-to/logs.mdx | 8 +++--- .../content/php/how-to/trigger-pipeline.mdx | 8 +++--- apps/docs/content/php/how-to/upgrade.mdx | 4 +-- apps/docs/content/php/tutorial/quickstart.mdx | 2 +- .../docs/content/php/tutorial/runtime-sql.mdx | 10 +++---- .../content/php/tutorial/step-by-step.mdx | 4 +-- apps/docs/content/postgresql/faq.mdx | 24 ++++++++--------- .../docs/content/postgresql/how-to/create.mdx | 12 ++++----- .../postgresql/tutorial/quickstart.mdx | 2 +- apps/docs/content/python/how-to/access.mdx | 6 ++--- .../content/python/how-to/build-pipeline.mdx | 22 ++++++++-------- .../content/python/how-to/build-process.mdx | 2 +- apps/docs/content/python/how-to/create.mdx | 16 ++++++------ .../python/how-to/customize-runtime.mdx | 6 ++--- .../content/python/how-to/deploy-process.mdx | 8 +++--- apps/docs/content/python/how-to/logs.mdx | 8 +++--- .../python/how-to/trigger-pipeline.mdx | 8 +++--- apps/docs/content/python/how-to/upgrade.mdx | 4 +-- .../content/python/tutorial/quickstart.mdx | 2 +- .../content/python/tutorial/runtime-sql.mdx | 10 +++---- .../content/python/tutorial/step-by-step.mdx | 4 +-- apps/docs/content/rabbitmq/how-to/create.mdx | 8 +++--- apps/docs/content/references/cli/commands.mdx | 2 +- apps/docs/content/references/vpn.mdx | 2 +- apps/docs/content/references/vpn/faq.mdx | 10 +++---- apps/docs/content/references/zeropsyml.mdx | 10 +++---- apps/docs/content/rust/how-to/access.mdx | 6 ++--- .../content/rust/how-to/build-pipeline.mdx | 16 ++++++------ .../content/rust/how-to/build-process.mdx | 2 +- apps/docs/content/rust/how-to/create.mdx | 16 ++++++------ .../content/rust/how-to/customize-runtime.mdx | 6 ++--- .../content/rust/how-to/deploy-process.mdx | 8 +++--- apps/docs/content/rust/how-to/logs.mdx | 8 +++--- .../content/rust/how-to/trigger-pipeline.mdx | 8 +++--- apps/docs/content/rust/how-to/upgrade.mdx | 4 +-- .../docs/content/rust/tutorial/quickstart.mdx | 2 +- .../content/rust/tutorial/runtime-sql.mdx | 10 +++---- .../content/rust/tutorial/step-by-step.mdx | 4 +-- 113 files changed, 434 insertions(+), 434 deletions(-) diff --git a/apps/docs/content/dotnet/how-to/access.mdx b/apps/docs/content/dotnet/how-to/access.mdx index 675c5521..31a6b88f 100644 --- a/apps/docs/content/dotnet/how-to/access.mdx +++ b/apps/docs/content/dotnet/how-to/access.mdx @@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers To connect to your application with `app` hostname running on [internal port](/dotnet/how-to/build-pipeline#ports) `5000`, simply use `http://app:5000` :::info -Do not use https:// when communicating with .NET from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with .NET from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. ::: ### Use .NET environment variables @@ -41,12 +41,12 @@ You can securely connect to your .NET application from your local workspace via Once the VPN session is established, you have the secured connection to the project's private network in Zerops. You can access all project services locally by using their hostname. The only difference is that no [environment variables](/dotnet/how-to/env-variables) are available when connected through VPN. To connect to your .NET application in Zerops set the hostname and [internal port](/dotnet/how-to/build-pipeline#ports) e.g. http://app:5000 :::info -Do not use https:// when communicating with .NET over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with .NET over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. ::: ### Connect via SSH -Use the ssh command to connect to your service via SSH. +Use the `ssh` command to connect to your service via SSH. ### Stop VPN connection diff --git a/apps/docs/content/dotnet/how-to/build-pipeline.mdx b/apps/docs/content/dotnet/how-to/build-pipeline.mdx index 54e6842e..5a4992b6 100644 --- a/apps/docs/content/dotnet/how-to/build-pipeline.mdx +++ b/apps/docs/content/dotnet/how-to/build-pipeline.mdx @@ -117,7 +117,7 @@ zerops:

The base build environment contains {data.alpineCurrentVersion}, the selected major version of .NET, Zerops command line tool,{' '} - ASP .NET and git. + `ASP .NET` and `git`.

:::info @@ -290,7 +290,7 @@ If the command ends successfully, it returns the exit code 0 and Zerops triggers ### 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. +_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. ```yml # REQUIRED. Select which files / folders to deploy after @@ -351,7 +351,7 @@ deployFiles: ./path/~/to/ #### .deployignore -Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a .gitignore file. +Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a `.gitignore` file. Example to ignore `src/file.txt` file in deploy: @@ -367,7 +367,7 @@ src / file.txt; ``` :::note -`.deployignore` file also works with zcli service deploy command. +`.deployignore` file also works with `zcli service deploy` command. ::: ### cache @@ -518,7 +518,7 @@ _OPTIONAL._ Customises the .NET runtime environment by installing additional dep

The base .NET environment contains {data.alpineCurrentVersion}, the selected major version of .NET, Zerops command line tool{' '} - and ASP .NET and git. To install additional packages + and `ASP .NET` and `git`. To install additional packages or tools add one or more prepare commands:

@@ -573,7 +573,7 @@ You can configure your prepare commands to be run in a single shell instance or The prepare runtime container contains {data.alpineCurrentVersion}, the selected major version of .NET,{' '} Zerops command line tool and{' '} - ASP .NET and git. + `ASP .NET` and `git`.

The prepare runtime container does not contain your application code nor the built application. If you need to copy some folders or files from the build container to the runtime container (e.g. a configuration file) use the `addToRunPrepare` attribute in the [build section](#build-pipeline-configuration). diff --git a/apps/docs/content/dotnet/how-to/build-process.mdx b/apps/docs/content/dotnet/how-to/build-process.mdx index 24ca694b..3834d45c 100644 --- a/apps/docs/content/dotnet/how-to/build-process.mdx +++ b/apps/docs/content/dotnet/how-to/build-process.mdx @@ -44,7 +44,7 @@ The default .NET build environment contains: - [zCLI](/references/cli), Zerops command line tool - ASP .NET`and`git` -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/dotnet/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/dotnet/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. :::info The application code is available in the `/var/www` folder in your build container before the prepare commands are triggered. This allows you to use any file from your application code in your prepare commands (e.g. a configuration file). diff --git a/apps/docs/content/dotnet/how-to/create.mdx b/apps/docs/content/dotnet/how-to/create.mdx index 3e0ba714..190a0e03 100644 --- a/apps/docs/content/dotnet/how-to/create.mdx +++ b/apps/docs/content/dotnet/how-to/create.mdx @@ -268,7 +268,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -283,16 +283,16 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type dotnet and version. + Specifies the service type `dotnet` and version.
Set type:{' '} - + ` dotnet@<version> - {' '} + `{' '} or{' '} - + ` dotnet@latest - + `

Limitations: @@ -319,8 +319,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/dotnet/how-to/customize-runtime.mdx b/apps/docs/content/dotnet/how-to/customize-runtime.mdx index da98c171..0e71a6bc 100644 --- a/apps/docs/content/dotnet/how-to/customize-runtime.mdx +++ b/apps/docs/content/dotnet/how-to/customize-runtime.mdx @@ -18,12 +18,12 @@ The default .NET runtime environment contains: - {data.alpineCurrentVersion} - selected version of .NET selected when the runtime service was created. - - zCLI + `zCLI` , Zerops command line tool - ASP .NET`and`git` -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more run.prepareCommands commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more `run.prepareCommands` commands to your `zerops.yml`. When the first deploy with a defined `prepareCommands` attribute is triggered, Zerops will @@ -41,7 +41,7 @@ The prepare runtime container is automatically deleted after the prepare runtime Some packages or tools can take a long time to install. Therefore, Zerops caches your custom runtime environment after the installation of your custom packages or tools is completed. When the second or following deploy is triggered, Zerops will use the custom runtime cache from the previous deploy if following conditions are met: -1. Content of the build.addToRunPrepare and run.prepareCommands attributes didn't change from the previous deploy +1. Content of the `build.addToRunPrepare` and `run.prepareCommands` attributes didn't change from the previous deploy 2. The custom runtime cache wasn't invalidated in the Zerops GUI. To invalidate the custom runtime cache go to `yyy` diff --git a/apps/docs/content/dotnet/how-to/deploy-process.mdx b/apps/docs/content/dotnet/how-to/deploy-process.mdx index 1edab680..ef2a1b0c 100644 --- a/apps/docs/content/dotnet/how-to/deploy-process.mdx +++ b/apps/docs/content/dotnet/how-to/deploy-process.mdx @@ -39,11 +39,11 @@ Zerops performs following actions for each new container: Services with multiple containers are deployed in parallel. :::info -If your application needs to be initialized in each runtime container, add [init commands](/dotnet/how-to/build-pipeline#initcommands) to zerops.yml. +If your application needs to be initialized in each runtime container, add [init commands](/dotnet/how-to/build-pipeline#initcommands) to `zerops.yml`. ::: :::caution -Do not use the initCommands for customising your runtime environment. See [how to customise the runtime environment](/dotnet/how-to/deploy-process#customise-dotnet-runtime-environment). +Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/dotnet/how-to/deploy-process#customise-dotnet-runtime-environment). ::: ## Further deploys @@ -70,9 +70,9 @@ Application in the runtime container with a pending readiness check won't receiv If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy. -The httpGet readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. +The `httpGet` readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. -The exec.command readiness check is successful when the command returns status code 0. The timeout is 5 seconds. +The `exec.command` readiness check is successful when the command returns status code 0. The timeout is 5 seconds. Read the [runtime log](/dotnet/how-to/logs#runtime-log) to troubleshoot failed readiness checks. diff --git a/apps/docs/content/dotnet/how-to/logs.mdx b/apps/docs/content/dotnet/how-to/logs.mdx index c8223649..8e3da547 100644 --- a/apps/docs/content/dotnet/how-to/logs.mdx +++ b/apps/docs/content/dotnet/how-to/logs.mdx @@ -88,11 +88,11 @@ app.Logger.LogInformation('<7>Debug (7) severity > debug-level message.'); :::info -logger.LogTrace, logger.LogInformation, -logger.LogWarning, logger.LogDebug, +`logger.LogTrace`, `logger.LogInformation`, +`logger.LogWarning`, `logger.LogDebug`, ` logger.LogError - and logger.LogCritical are just aliases to the +` and `logger.LogCritical` are just aliases to the ` logger.LogInformation - method. They don't set the appropriate severity number. Use the +` method. They don't set the appropriate severity number. Use the ` <N> - prefix instead. ::: +` prefix instead. ::: diff --git a/apps/docs/content/dotnet/how-to/trigger-pipeline.mdx b/apps/docs/content/dotnet/how-to/trigger-pipeline.mdx index 77bd5c7e..01cc39af 100644 --- a/apps/docs/content/dotnet/how-to/trigger-pipeline.mdx +++ b/apps/docs/content/dotnet/how-to/trigger-pipeline.mdx @@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t

:::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ### Skip the automatic pipeline once @@ -60,7 +60,7 @@ To start a new build & deploy pipeline manually, use the Zerops CLI. Follow these steps: -1. Add zerops.yml to your repository. +1. Add `zerops.yml` to your repository. 2. [Install & setup zCLI](/references/cli) the Zerops command line tool. 3. Run `zcli push` command. @@ -96,7 +96,7 @@ Flags: zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from. :::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ## Manual deploy using Zerops CLI @@ -138,5 +138,5 @@ Flags: `zerops.yml` must be placed in the working directory. :::info -You can change the deploy pipeline when you need to. Just simply modify the zerops.yml in your working directory. +You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory. ::: diff --git a/apps/docs/content/dotnet/how-to/upgrade.mdx b/apps/docs/content/dotnet/how-to/upgrade.mdx index 5ab6995a..07740ecc 100644 --- a/apps/docs/content/dotnet/how-to/upgrade.mdx +++ b/apps/docs/content/dotnet/how-to/upgrade.mdx @@ -2,6 +2,6 @@ title: How to upgrade the .NET version --- -You can upgrade or downgrade your .NET service to a different major .NET version by setting the run.base parameter in your `zerops.yml`. When you [trigger a new pipeline](/dotnet/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required .NET version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current .NET version for your runtime. +You can upgrade or downgrade your .NET service to a different major .NET version by setting the `run.base` parameter in your `zerops.yml`. When you [trigger a new pipeline](/dotnet/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required .NET version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current .NET version for your runtime. -If you want to build your application with a different major .NET version, change the build.base parameter in your `zerops.yml`. The `build.base` is the required attribute. +If you want to build your application with a different major .NET version, change the `build.base` parameter in your `zerops.yml`. The `build.base` is the required attribute. diff --git a/apps/docs/content/dotnet/tutorial/quickstart.mdx b/apps/docs/content/dotnet/tutorial/quickstart.mdx index 6f4024cf..7fde9f7f 100644 --- a/apps/docs/content/dotnet/tutorial/quickstart.mdx +++ b/apps/docs/content/dotnet/tutorial/quickstart.mdx @@ -29,7 +29,7 @@ services: **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://helloworld-24-8080.prg1.zerops.app`. -2. Click or the subdomain URL to open it in a browser and you should see +2. Click or the `subdomain` URL to open it in a browser and you should see ``` Hello, World! diff --git a/apps/docs/content/dotnet/tutorial/runtime-sql.mdx b/apps/docs/content/dotnet/tutorial/runtime-sql.mdx index 5af61fdd..8b4cef44 100644 --- a/apps/docs/content/dotnet/tutorial/runtime-sql.mdx +++ b/apps/docs/content/dotnet/tutorial/runtime-sql.mdx @@ -32,7 +32,7 @@ In the detail of each step, you can find a link with more information about the
3. In the left menu, click on Import services, copy & paste the - contents of the import-services.yml config file from the recipe + contents of the `import-services.yml` config file from the recipe repository of your choice. Then click on Import service.

@@ -45,7 +45,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -75,7 +75,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 + 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

`Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1`

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. @@ -86,14 +86,14 @@ For now, check out other features, such as access it.

Learn more about how to{' '} - use psql + use `psql` {' '} command-line tool instead or how to{' '} import and export data{' '} diff --git a/apps/docs/content/dotnet/tutorial/step-by-step.mdx b/apps/docs/content/dotnet/tutorial/step-by-step.mdx index 1281b378..40489e7c 100644 --- a/apps/docs/content/dotnet/tutorial/step-by-step.mdx +++ b/apps/docs/content/dotnet/tutorial/step-by-step.mdx @@ -48,7 +48,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -78,7 +78,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with Hello World! printed. + 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with `Hello World!` printed.

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. diff --git a/apps/docs/content/elasticsearch/how-to/create.mdx b/apps/docs/content/elasticsearch/how-to/create.mdx index 023c9f82..ae7b06db 100644 --- a/apps/docs/content/elasticsearch/how-to/create.mdx +++ b/apps/docs/content/elasticsearch/how-to/create.mdx @@ -200,14 +200,14 @@ At least one service in `services:` section is required. You can create a projec hostname - The unique service identifier.

The hostname of the new database will be set to the hostname value.

Limitations:
- duplicate services with the same name in the same project are forbidden
+ The unique service identifier.

The hostname of the new database will be set to the `hostname` value.

Limitations:
- duplicate services with the same name in the same project are forbidden
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9) type - Specifies the service type elasticsearch and version.
Set type: elasticsearch@7

Limitations:
Currently Elasticsearch versions 6 and 7 are available. + Specifies the service type `elasticsearch` and version.
Set type: `elasticsearch@7`

Limitations:
Currently Elasticsearch versions 6 and 7 are available. @@ -245,8 +245,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED values. - Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED` values. + Default is `SHARED` diff --git a/apps/docs/content/features/pipeline.mdx b/apps/docs/content/features/pipeline.mdx index 5567b6ac..bc238c2d 100644 --- a/apps/docs/content/features/pipeline.mdx +++ b/apps/docs/content/features/pipeline.mdx @@ -203,11 +203,11 @@ Zerops performs following actions for each new container: Services with multiple containers are deployed in parallel. :::info -If your application needs to be initialized in each runtime container, add [init commands](/go/how-to/build-pipeline#initcommands) to zerops.yml. +If your application needs to be initialized in each runtime container, add [init commands](/go/how-to/build-pipeline#initcommands) to `zerops.yml`. ::: :::caution -Do not use the initCommands for customising your runtime environment. See [how to customise the runtime environment](/go/how-to/deploy-process#customise-go-runtime-environment). +Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/go/how-to/deploy-process#customise-go-runtime-environment). ::: ### Further deploys @@ -234,9 +234,9 @@ Application in the runtime container with a pending readiness check won't receiv If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy. -The httpGet readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. +The `httpGet` readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. -The exec.command readiness check is successful when the command returns status code 0. The timeout is 5 seconds. +The `exec.command` readiness check is successful when the command returns status code 0. The timeout is 5 seconds. Read the [runtime log](/nodejs/how-to/logs#runtime-log) to troubleshoot failed readiness checks. @@ -290,7 +290,7 @@ When the custom runtime cache is used, Zerops doesn't create a prepare runtime c To start only a deploy pipeline, use the [Zerops CLI](/references/cli). zCLI is the Zerops command-line tool. -The zcli service deploy command uploads your application and deploys it in Zerops. Use this tool if you have your own build process. If you want to build your application in Zerops, use an [automatic](#automatically) or [manual](#manually) build process. +The `zcli service deploy` command uploads your application and deploys it in Zerops. Use this tool if you have your own build process. If you want to build your application in Zerops, use an [automatic](#automatically) or [manual](#manually) build process. ```sh Usage: @@ -317,7 +317,7 @@ Flags: `zerops.yml` must be placed in the working directory. :::info -You can change the deploy pipeline when you need to. Just simply modify the zerops.yml in your working directory. +You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory. ::: ## Manage build and deploys diff --git a/apps/docs/content/go/how-to/access.mdx b/apps/docs/content/go/how-to/access.mdx index 89aa4038..42559424 100644 --- a/apps/docs/content/go/how-to/access.mdx +++ b/apps/docs/content/go/how-to/access.mdx @@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers To connect to your application with `app` hostname running on [internal port](/go/how-to/build-pipeline#ports) `8080`, simply use `http://app:8080` :::info -Do not use https:// when communicating with Go from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Go from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. ::: ### Use Go environment variables @@ -41,12 +41,12 @@ You can securely connect to your Go application from your local workspace via Ze Once the VPN session is established, you have the secured connection to the project's private network in Zerops. You can access all project services locally by using their hostname. The only difference is that no [environment variables](/go/how-to/env-variables) are available when connected through VPN. To connect to your Go application in Zerops set the hostname and [internal port](/go/how-to/build-pipeline#ports) e.g. http://app:8080 :::info -Do not use https:// when communicating with Go over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Go over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. ::: ### Connect via SSH -Use the ssh command to connect to your service via SSH. +Use the `ssh` command to connect to your service via SSH. ### Stop VPN connection diff --git a/apps/docs/content/go/how-to/build-pipeline.mdx b/apps/docs/content/go/how-to/build-pipeline.mdx index 7d4ed1cf..7eeb39c6 100644 --- a/apps/docs/content/go/how-to/build-pipeline.mdx +++ b/apps/docs/content/go/how-to/build-pipeline.mdx @@ -112,7 +112,7 @@ zerops:

The base build environment contains {data.alpineCurrentVersion}, the selected version of Go, Zerops command line tool,{' '} - git and wget. + `git` and `wget`.

:::info @@ -285,7 +285,7 @@ If the command ends successfully, it returns the exit code 0 and Zerops triggers ### 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. +_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. ```yml # REQUIRED. Select which files / folders to deploy after @@ -346,7 +346,7 @@ deployFiles: ./path/~/to/ #### .deployignore -Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a .gitignore file. +Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a `.gitignore` file. Example to ignore `src/file.txt` file in deploy: @@ -362,7 +362,7 @@ src / file.txt; ``` :::note -`.deployignore` file also works with zcli service deploy command. +`.deployignore` file also works with `zcli service deploy` command. ::: ### cache @@ -436,8 +436,8 @@ zerops:

The base runtime environment contains {data.alpineCurrentVersion}, the - selected major version of Go, Zerops command line tool, git and{' '} - wget. + selected major version of Go, Zerops command line tool, `git` and{' '} + `wget`.

:::info @@ -512,7 +512,7 @@ _OPTIONAL._ Customises the Go runtime environment by installing additional depen

The base Go environment contains {data.alpineCurrentVersion}, the selected major version of Go, Zerops command line tool{' '} - and git and wget. To install additional packages or + and `git` and `wget`. To install additional packages or tools add one or more prepare commands:

@@ -566,8 +566,8 @@ You can configure your prepare commands to be run in a single shell instance or

The prepare runtime container contains {data.alpineCurrentVersion}, the selected major version of Go,{' '} - Zerops command line tool and git{' '} - and wget. + Zerops command line tool and `git`{' '} + and `wget`.

The prepare runtime container does not contain your application code nor the built application. If you need to copy some folders or files from the build container to the runtime container (e.g. a configuration file) use the `addToRunPrepare` attribute in the [build section](#build-pipeline-configuration). diff --git a/apps/docs/content/go/how-to/build-process.mdx b/apps/docs/content/go/how-to/build-process.mdx index 8f773cd6..cd81cf9f 100644 --- a/apps/docs/content/go/how-to/build-process.mdx +++ b/apps/docs/content/go/how-to/build-process.mdx @@ -44,7 +44,7 @@ The default Go build environment contains: - [zCLI](/references/cli), Zerops command line tool - `git` and `wget` -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/go/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/go/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. :::info The application code is available in the `/var/www` folder in your build container before the prepare commands are triggered. This allows you to use any file from your application code in your prepare commands (e.g. a configuration file). diff --git a/apps/docs/content/go/how-to/create.mdx b/apps/docs/content/go/how-to/create.mdx index 38eceb69..7896cebf 100644 --- a/apps/docs/content/go/how-to/create.mdx +++ b/apps/docs/content/go/how-to/create.mdx @@ -264,7 +264,7 @@ At least one service in `services:` section is required. You can create a projec hostname - The unique service identifier.

The hostname of the new database will be set to the hostname value.

Limitations:
- duplicate services with the same name in the same project are forbidden
+ The unique service identifier.

The hostname of the new database will be set to the `hostname` value.

Limitations:
- duplicate services with the same name in the same project are forbidden
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9) @@ -272,7 +272,7 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type go and version.
Set type: go@<version> or go@latest

Limitations:
Following Go major versions are currently supported: 1.22 + Specifies the service type `go` and version.
Set type: `go@<version>` or `go@latest`

Limitations:
Following Go major versions are currently supported: 1.22 {" "} @@ -296,8 +296,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED values. - Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED` values. + Default is `SHARED` diff --git a/apps/docs/content/go/how-to/customize-runtime.mdx b/apps/docs/content/go/how-to/customize-runtime.mdx index 99ead636..b42cd353 100644 --- a/apps/docs/content/go/how-to/customize-runtime.mdx +++ b/apps/docs/content/go/how-to/customize-runtime.mdx @@ -18,12 +18,12 @@ The default Go runtime environment contains: - {data.alpineCurrentVersion} - selected version of Go selected when the runtime service was created. - - zCLI + `zCLI` , Zerops command line tool - `git` and `wget` -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more run.prepareCommands commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more `run.prepareCommands` commands to your `zerops.yml`. When the first deploy with a defined `prepareCommands` attribute is triggered, Zerops will @@ -41,7 +41,7 @@ The prepare runtime container is automatically deleted after the prepare runtime Some packages or tools can take a long time to install. Therefore, Zerops caches your custom runtime environment after the installation of your custom packages or tools is completed. When the second or following deploy is triggered, Zerops will use the custom runtime cache from the previous deploy if following conditions are met: -1. Content of the build.addToRunPrepare and run.prepareCommands attributes didn't change from the previous deploy +1. Content of the `build.addToRunPrepare` and `run.prepareCommands` attributes didn't change from the previous deploy 2. The custom runtime cache wasn't invalidated in the Zerops GUI. To invalidate the custom runtime cache go to `yyy` diff --git a/apps/docs/content/go/how-to/deploy-process.mdx b/apps/docs/content/go/how-to/deploy-process.mdx index fe55c173..5e53a68c 100644 --- a/apps/docs/content/go/how-to/deploy-process.mdx +++ b/apps/docs/content/go/how-to/deploy-process.mdx @@ -39,11 +39,11 @@ Zerops performs following actions for each new container: Services with multiple containers are deployed in parallel. :::info -If your application needs to be initialized in each runtime container, add [init commands](/go/how-to/build-pipeline#initcommands) to zerops.yml. +If your application needs to be initialized in each runtime container, add [init commands](/go/how-to/build-pipeline#initcommands) to `zerops.yml`. ::: :::caution -Do not use the initCommands for customising your runtime environment. See [how to customise the runtime environment](/go/how-to/deploy-process#customise-go-runtime-environment). +Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/go/how-to/deploy-process#customise-go-runtime-environment). ::: ## Further deploys @@ -70,9 +70,9 @@ Application in the runtime container with a pending readiness check won't receiv If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy. -The httpGet readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. +The `httpGet` readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. -The exec.command readiness check is successful when the command returns status code 0. The timeout is 5 seconds. +The `exec.command` readiness check is successful when the command returns status code 0. The timeout is 5 seconds. Read the [runtime log](/go/how-to/logs#runtime-log) to troubleshoot failed readiness checks. diff --git a/apps/docs/content/go/how-to/logs.mdx b/apps/docs/content/go/how-to/logs.mdx index 22367de6..71233f39 100644 --- a/apps/docs/content/go/how-to/logs.mdx +++ b/apps/docs/content/go/how-to/logs.mdx @@ -86,8 +86,8 @@ slog.Info("<7>Debug (7) severity > debug-level message.") :::info -slog.Info, slog.Debug, slog.Warn, and +`slog.Info`, `slog.Debug`, `slog.Warn`, and ` slog.Error - are just aliases to the slog.Info method. They don't set -the appropriate severity number. Use the <N> prefix instead. +` are just aliases to the `slog.Info` method. They don't set +the appropriate severity number. Use the `<N>` prefix instead. ::: diff --git a/apps/docs/content/go/how-to/trigger-pipeline.mdx b/apps/docs/content/go/how-to/trigger-pipeline.mdx index 945a9666..fbdf7706 100644 --- a/apps/docs/content/go/how-to/trigger-pipeline.mdx +++ b/apps/docs/content/go/how-to/trigger-pipeline.mdx @@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t

:::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ### Skip the automatic pipeline once @@ -60,7 +60,7 @@ To start a new build & deploy pipeline manually, use the Zerops CLI. Follow these steps: -1. Add zerops.yml to your repository. +1. Add `zerops.yml` to your repository. 2. [Install & setup zCLI](/references/cli) the Zerops command line tool. 3. Run `zcli push` command. @@ -96,7 +96,7 @@ Flags: zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from. :::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ## Manual deploy using Zerops CLI @@ -138,5 +138,5 @@ Flags: `zerops.yml` must be placed in the working directory. :::info -You can change the deploy pipeline when you need to. Just simply modify the zerops.yml in your working directory. +You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory. ::: diff --git a/apps/docs/content/go/how-to/upgrade.mdx b/apps/docs/content/go/how-to/upgrade.mdx index 735d3721..a634d874 100644 --- a/apps/docs/content/go/how-to/upgrade.mdx +++ b/apps/docs/content/go/how-to/upgrade.mdx @@ -2,6 +2,6 @@ title: How to upgrade the Go version --- -You can upgrade or downgrade your Go service to a different major Go version by setting the run.base parameter in your `zerops.yml`. When you [trigger a new pipeline](/go/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Go version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Go version for your runtime. +You can upgrade or downgrade your Go service to a different major Go version by setting the `run.base` parameter in your `zerops.yml`. When you [trigger a new pipeline](/go/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Go version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Go version for your runtime. -If you want to build your application with a different major Go version, change the build.base parameter in your `zerops.yml`. The `build.base` is the required attribute. +If you want to build your application with a different major Go version, change the `build.base` parameter in your `zerops.yml`. The `build.base` is the required attribute. diff --git a/apps/docs/content/go/tutorial/quickstart.mdx b/apps/docs/content/go/tutorial/quickstart.mdx index 3466dd99..b10bd690 100644 --- a/apps/docs/content/go/tutorial/quickstart.mdx +++ b/apps/docs/content/go/tutorial/quickstart.mdx @@ -29,7 +29,7 @@ services: **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://helloworld-24-8080.prg1.zerops.app`. -2. Click or the subdomain URL to open it in a browser and you should see +2. Click or the `subdomain` URL to open it in a browser and you should see ``` Hello, World! diff --git a/apps/docs/content/go/tutorial/runtime-sql.mdx b/apps/docs/content/go/tutorial/runtime-sql.mdx index 7f0a30d7..755be954 100644 --- a/apps/docs/content/go/tutorial/runtime-sql.mdx +++ b/apps/docs/content/go/tutorial/runtime-sql.mdx @@ -32,7 +32,7 @@ In the detail of each step, you can find a link with more information about the
3. In the left menu, click on Import services, copy & paste the - contents of the import-services.yml config file from the recipe + contents of the `import-services.yml` config file from the recipe repository of your choice. Then click on Import service.

@@ -45,7 +45,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -75,7 +75,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 + 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

`Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1`

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. @@ -86,14 +86,14 @@ For now, check out other features, such as en

- 7. One of the services is adminer, a database management tool. + 7. One of the services is `adminer`, a database management tool. See how to{' '} access it.

Learn more about how to{' '} - use psql + use `psql` {' '} command-line tool instead or how to{' '} import and export data{' '} diff --git a/apps/docs/content/go/tutorial/step-by-step.mdx b/apps/docs/content/go/tutorial/step-by-step.mdx index 03f37b68..a3ed0d6d 100644 --- a/apps/docs/content/go/tutorial/step-by-step.mdx +++ b/apps/docs/content/go/tutorial/step-by-step.mdx @@ -48,7 +48,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -78,7 +78,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with Hello World! printed. + 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with `Hello World!` printed.

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. diff --git a/apps/docs/content/java/how-to/access.mdx b/apps/docs/content/java/how-to/access.mdx index 5cc53981..2d005a60 100644 --- a/apps/docs/content/java/how-to/access.mdx +++ b/apps/docs/content/java/how-to/access.mdx @@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers To connect to your application with `app` hostname running on [internal port](/java/how-to/build-pipeline#ports) `8080`, simply use `http://app:8080` :::info -Do not use https:// when communicating with Java from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Java from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. ::: ### Use Java environment variables @@ -41,12 +41,12 @@ You can securely connect to your Java application from your local workspace via Once the VPN session is established, you have the secured connection to the project's private network in Zerops. You can access all project services locally by using their hostname. The only difference is that no [environment variables](/java/how-to/env-variables) are available when connected through VPN. To connect to your Java application in Zerops set the hostname and [internal port](/java/how-to/build-pipeline#ports) e.g. http://app:8080 :::info -Do not use https:// when communicating with Java over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Java over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. ::: ### Connect via SSH -Use the ssh command to connect to your service via SSH. +Use the `ssh` command to connect to your service via SSH. ### Stop VPN connection diff --git a/apps/docs/content/java/how-to/build-pipeline.mdx b/apps/docs/content/java/how-to/build-pipeline.mdx index d5b55ddb..96b5dfb9 100644 --- a/apps/docs/content/java/how-to/build-pipeline.mdx +++ b/apps/docs/content/java/how-to/build-pipeline.mdx @@ -285,7 +285,7 @@ If the command ends successfully, it returns the exit code 0 and Zerops triggers ### 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. +_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. ```yml # REQUIRED. Select which files / folders to deploy after @@ -346,7 +346,7 @@ deployFiles: ./path/~/to/ #### .deployignore -Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a .gitignore file. +Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a `.gitignore` file. Example to ignore `src/file.txt` file in deploy: @@ -362,7 +362,7 @@ src / file.txt; ``` :::note -`.deployignore` file also works with zcli service deploy command. +`.deployignore` file also works with `zcli service deploy` command. ::: ### cache diff --git a/apps/docs/content/java/how-to/build-process.mdx b/apps/docs/content/java/how-to/build-process.mdx index e6be0ec6..a46abdf9 100644 --- a/apps/docs/content/java/how-to/build-process.mdx +++ b/apps/docs/content/java/how-to/build-process.mdx @@ -44,7 +44,7 @@ The default Java build environment contains: - [zCLI](/references/cli), Zerops command line tool - `git` and `wget` -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/java/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/java/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. :::info The application code is available in the `/var/www` folder in your build container before the prepare commands are triggered. This allows you to use any file from your application code in your prepare commands (e.g. a configuration file). diff --git a/apps/docs/content/java/how-to/create.mdx b/apps/docs/content/java/how-to/create.mdx index cff578d8..cc649679 100644 --- a/apps/docs/content/java/how-to/create.mdx +++ b/apps/docs/content/java/how-to/create.mdx @@ -264,7 +264,7 @@ At least one service in `services:` section is required. You can create a projec hostname - The unique service identifier.

The hostname of the new database will be set to the hostname value.

Limitations:
- duplicate services with the same name in the same project are forbidden
+ The unique service identifier.

The hostname of the new database will be set to the `hostname` value.

Limitations:
- duplicate services with the same name in the same project are forbidden
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9) @@ -272,7 +272,7 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type java and version.
Set type: java@<version> or java@latest

Limitations:
Following Java major versions are currently supported: 1.22 + Specifies the service type `java` and version.
Set type: `java@<version>` or `java@latest`

Limitations:
Following Java major versions are currently supported: 1.22 {" "} @@ -296,8 +296,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED values. - Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED` values. + Default is `SHARED` diff --git a/apps/docs/content/java/how-to/customize-runtime.mdx b/apps/docs/content/java/how-to/customize-runtime.mdx index 8cc2f8aa..e1f7f96e 100644 --- a/apps/docs/content/java/how-to/customize-runtime.mdx +++ b/apps/docs/content/java/how-to/customize-runtime.mdx @@ -18,12 +18,12 @@ The default Java runtime environment contains: - {data.alpineVersion} - selected version of Java selected when the runtime service was created. - - zCLI + `zCLI` , Zerops command line tool - `git` and `wget` -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more run.prepareCommands commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more `run.prepareCommands` commands to your `zerops.yml`. When the first deploy with a defined `prepareCommands` attribute is triggered, Zerops will @@ -41,7 +41,7 @@ The prepare runtime container is automatically deleted after the prepare runtime Some packages or tools can take a long time to install. Therefore, Zerops caches your custom runtime environment after the installation of your custom packages or tools is completed. When the second or following deploy is triggered, Zerops will use the custom runtime cache from the previous deploy if following conditions are met: -1. Content of the build.addToRunPrepare and run.prepareCommands attributes didn't change from the previous deploy +1. Content of the `build.addToRunPrepare` and `run.prepareCommands` attributes didn't change from the previous deploy 2. The custom runtime cache wasn't invalidated in the Zerops GUI. To invalidate the custom runtime cache go to `yyy` diff --git a/apps/docs/content/java/how-to/deploy-process.mdx b/apps/docs/content/java/how-to/deploy-process.mdx index 7fc346fb..43040a49 100644 --- a/apps/docs/content/java/how-to/deploy-process.mdx +++ b/apps/docs/content/java/how-to/deploy-process.mdx @@ -39,11 +39,11 @@ Zerops performs following actions for each new container: Services with multiple containers are deployed in parallel. :::info -If your application needs to be initialized in each runtime container, add [init commands](/java/how-to/build-pipeline#initcommands) to zerops.yml. +If your application needs to be initialized in each runtime container, add [init commands](/java/how-to/build-pipeline#initcommands) to `zerops.yml`. ::: :::caution -Do not use the initCommands for customising your runtime environment. See [how to customise the runtime environment](/java/how-to/deploy-process#customise-java-runtime-environment). +Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/java/how-to/deploy-process#customise-java-runtime-environment). ::: ## Further deploys @@ -70,9 +70,9 @@ Application in the runtime container with a pending readiness check won't receiv If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy. -The httpGet readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. +The `httpGet` readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. -The exec.command readiness check is successful when the command returns status code 0. The timeout is 5 seconds. +The `exec.command` readiness check is successful when the command returns status code 0. The timeout is 5 seconds. Read the [runtime log](/java/how-to/logs#runtime-log) to troubleshoot failed readiness checks. diff --git a/apps/docs/content/java/how-to/logs.mdx b/apps/docs/content/java/how-to/logs.mdx index 347a8089..f6977bec 100644 --- a/apps/docs/content/java/how-to/logs.mdx +++ b/apps/docs/content/java/how-to/logs.mdx @@ -93,7 +93,7 @@ public class LogClass { :::info -log.trace, log.info, log.debug, -log.warn,log.error, and log.fatal are -just aliases to the log.Info method. They don't set the appropriate -severity number. Use the <N> prefix instead. ::: +`log.trace`, `log.info`, `log.debug`, +`log.warn`,`log.error`, and `log.fatal` are +just aliases to the `log.Info` method. They don't set the appropriate +severity number. Use the `<N>` prefix instead. ::: diff --git a/apps/docs/content/java/how-to/trigger-pipeline.mdx b/apps/docs/content/java/how-to/trigger-pipeline.mdx index 0c134025..1eb63f69 100644 --- a/apps/docs/content/java/how-to/trigger-pipeline.mdx +++ b/apps/docs/content/java/how-to/trigger-pipeline.mdx @@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t

:::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ### Skip the automatic pipeline once @@ -60,7 +60,7 @@ To start a new build & deploy pipeline manually, use the Zerops CLI. Follow these steps: -1. Add zerops.yml to your repository. +1. Add `zerops.yml` to your repository. 2. [Install & setup zCLI](/references/cli) the Zerops command line tool. 3. Run `zcli push` command. @@ -96,7 +96,7 @@ Flags: zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from. :::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ## Manual deploy using Zerops CLI @@ -138,5 +138,5 @@ Flags: `zerops.yml` must be placed in the working directory. :::info -You can change the deploy pipeline when you need to. Just simply modify the zerops.yml in your working directory. +You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory. ::: diff --git a/apps/docs/content/java/how-to/upgrade.mdx b/apps/docs/content/java/how-to/upgrade.mdx index 53c39055..12e49a1d 100644 --- a/apps/docs/content/java/how-to/upgrade.mdx +++ b/apps/docs/content/java/how-to/upgrade.mdx @@ -2,6 +2,6 @@ title: How to upgrade the Java version --- -You can upgrade or downgrade your Java service to a different major Java version by setting the run.base parameter in your `zerops.yml`. When you [trigger a new pipeline](/java/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Java version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Java version for your runtime. +You can upgrade or downgrade your Java service to a different major Java version by setting the `run.base` parameter in your `zerops.yml`. When you [trigger a new pipeline](/java/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Java version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Java version for your runtime. -If you want to build your application with a different major Java version, change the build.base parameter in your `zerops.yml`. The `build.base` is the required attribute. +If you want to build your application with a different major Java version, change the `build.base` parameter in your `zerops.yml`. The `build.base` is the required attribute. diff --git a/apps/docs/content/java/tutorial/quickstart.mdx b/apps/docs/content/java/tutorial/quickstart.mdx index 2ec97918..5007a954 100644 --- a/apps/docs/content/java/tutorial/quickstart.mdx +++ b/apps/docs/content/java/tutorial/quickstart.mdx @@ -29,7 +29,7 @@ services: **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://helloworld-24-8080.prg1.zerops.app`. -2. Click or the subdomain URL to open it in a browser and you should see +2. Click or the `subdomain` URL to open it in a browser and you should see ``` Hello, World! diff --git a/apps/docs/content/java/tutorial/runtime-sql.mdx b/apps/docs/content/java/tutorial/runtime-sql.mdx index c090f351..bf5a8a56 100644 --- a/apps/docs/content/java/tutorial/runtime-sql.mdx +++ b/apps/docs/content/java/tutorial/runtime-sql.mdx @@ -32,7 +32,7 @@ In the detail of each step, you can find a link with more information about the
3. In the left menu, click on Import services, copy & paste the - contents of the import-services.yml config file from the recipe + contents of the `import-services.yml` config file from the recipe repository of your choice. Then click on Import service.

@@ -45,7 +45,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -75,7 +75,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 + 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

`Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1`

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. @@ -86,14 +86,14 @@ For now, check out other features, such as

- 7. One of the services is adminer, a database management tool. + 7. One of the services is `adminer`, a database management tool. See how to{' '} access it.

Learn more about how to{' '} - use psql + use `psql` {' '} command-line tool instead or how to{' '} import and export data{' '} diff --git a/apps/docs/content/java/tutorial/step-by-step.mdx b/apps/docs/content/java/tutorial/step-by-step.mdx index 537978ea..99d7218b 100644 --- a/apps/docs/content/java/tutorial/step-by-step.mdx +++ b/apps/docs/content/java/tutorial/step-by-step.mdx @@ -48,7 +48,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -78,7 +78,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with Hello World! printed. + 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with `Hello World!` printed.

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. diff --git a/apps/docs/content/keydb/how-to/create.mdx b/apps/docs/content/keydb/how-to/create.mdx index 1005f9de..302bbda7 100644 --- a/apps/docs/content/keydb/how-to/create.mdx +++ b/apps/docs/content/keydb/how-to/create.mdx @@ -213,7 +213,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -228,12 +228,12 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type keydb and version. + Specifies the service type `keydb` and version.
Set type:{' '} - + ` keydb@XXX - + ` Currently only KeyDB XXX is available. @@ -292,8 +292,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/keydb/tutorial/quickstart.mdx b/apps/docs/content/keydb/tutorial/quickstart.mdx index 29762c7b..8995ca6e 100644 --- a/apps/docs/content/keydb/tutorial/quickstart.mdx +++ b/apps/docs/content/keydb/tutorial/quickstart.mdx @@ -73,7 +73,7 @@ As said, there is no need for coding yet, we have created multiple repositories, **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://golang1-24-8080.prg1.zerops.app`. -2. Click or the subdomain URL to open it in a browser and you should see +2. Click or the `subdomain` URL to open it in a browser and you should see ``` Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 diff --git a/apps/docs/content/mariadb/how-to/create.mdx b/apps/docs/content/mariadb/how-to/create.mdx index f546d533..08de3fcf 100644 --- a/apps/docs/content/mariadb/how-to/create.mdx +++ b/apps/docs/content/mariadb/how-to/create.mdx @@ -213,7 +213,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -228,12 +228,12 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type mariadb and version. + Specifies the service type `mariadb` and version.
Set type:{' '} - + ` mariadb@10.4 - + `

Limitations: @@ -300,8 +300,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/mariadb/tutorial/quickstart.mdx b/apps/docs/content/mariadb/tutorial/quickstart.mdx index b1e0b2ec..dae1180f 100644 --- a/apps/docs/content/mariadb/tutorial/quickstart.mdx +++ b/apps/docs/content/mariadb/tutorial/quickstart.mdx @@ -71,7 +71,7 @@ As said, there is no need for coding yet, we have created multiple repositories, **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://golang1-24-8080.prg1.zerops.app`. -2. Click on the subdomain URL to open it in a browser and you should see: +2. Click on the `subdomain` URL to open it in a browser and you should see: ``` Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 diff --git a/apps/docs/content/mongodb/how-to/create.mdx b/apps/docs/content/mongodb/how-to/create.mdx index e85b58db..8401c0eb 100644 --- a/apps/docs/content/mongodb/how-to/create.mdx +++ b/apps/docs/content/mongodb/how-to/create.mdx @@ -206,7 +206,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -221,12 +221,12 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type mongodb and version. + Specifies the service type `mongodb` and version.
Set type:{' '} - + ` mongodb@4 - + ` Currently only MongoDB 4 is available. @@ -285,8 +285,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/nginx/how-to/access.mdx b/apps/docs/content/nginx/how-to/access.mdx index 63ec0c90..66272507 100644 --- a/apps/docs/content/nginx/how-to/access.mdx +++ b/apps/docs/content/nginx/how-to/access.mdx @@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers To connect to your application with `app` hostname running on [internal port](/nginx/how-to/build-pipeline#ports) `80`, simply use `http://app:80` :::info -Do not use https:// when communicating with Nginx from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Nginx from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. ::: ### Use Nginx environment variables @@ -41,12 +41,12 @@ You can securely connect to your Nginx application from your local workspace via Once the VPN session is established, you have the secured connection to the project's private network in Zerops. You can access all project services locally by using their hostname. The only difference is that no [environment variables](/nginx/how-to/env-variables) are available when connected through VPN. To connect to your Nginx application in Zerops set the hostname and [internal port](/nginx/how-to/build-pipeline#ports) e.g. http://app:80 :::info -Do not use https:// when communicating with Nginx over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Nginx over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. ::: ### Connect via SSH -Use the ssh command to connect to your service via SSH. +Use the `ssh` command to connect to your service via SSH. ### Stop VPN connection diff --git a/apps/docs/content/nginx/how-to/build-pipeline.mdx b/apps/docs/content/nginx/how-to/build-pipeline.mdx index 63edf7f1..498447fd 100644 --- a/apps/docs/content/nginx/how-to/build-pipeline.mdx +++ b/apps/docs/content/nginx/how-to/build-pipeline.mdx @@ -151,7 +151,7 @@ zerops: The base runtime environment contains {data.alpineCurrentVersion}, the selected major version of Nginx,{' '} Zerops command line tool and{' '} - composer, git and wget. + `composer`, `git` and `wget`.

:::info @@ -238,7 +238,7 @@ _OPTIONAL._ Customises the Nginx runtime environment by installing additional de

The base Nginx environment contains {data.alpineCurrentVersion}, the selected major version of Nginx, Zerops command line tool{' '} - and composer, git and wget. To install + and `composer`, `git` and `wget`. To install additional packages or tools add one or more prepare commands:

@@ -300,7 +300,7 @@ You can configure your prepare commands to be run in a single shell instance or The prepare runtime container contains {data.alpineCurrentVersion}, the selected major version of Nginx,{' '} Zerops command line tool and{' '} - composer, git and wget. + `composer`, `git` and `wget`.

The prepare runtime container does not contain your application code nor the built application. If you need to copy some folders or files from the build container to the runtime container (e.g. a configuration file) use the `addToRunPrepare` attribute in the [build section](#build-pipeline-configuration). diff --git a/apps/docs/content/nginx/how-to/create.mdx b/apps/docs/content/nginx/how-to/create.mdx index c2f32594..a1c5ee42 100644 --- a/apps/docs/content/nginx/how-to/create.mdx +++ b/apps/docs/content/nginx/how-to/create.mdx @@ -258,7 +258,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -273,16 +273,16 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type nginx and version. + Specifies the service type `nginx` and version.
Set type:{' '} - + ` nginx@<version> - {' '} + `{' '} or{' '} - + ` nginx@latest - + `

Limitations: @@ -309,8 +309,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/nginx/how-to/customize-runtime.mdx b/apps/docs/content/nginx/how-to/customize-runtime.mdx index 6f909b19..c97b167f 100644 --- a/apps/docs/content/nginx/how-to/customize-runtime.mdx +++ b/apps/docs/content/nginx/how-to/customize-runtime.mdx @@ -18,12 +18,12 @@ The default Nginx runtime environment contains: - {data.alpineCurrentVersion} - selected version of Nginx selected when the runtime service was created. - - zCLI + `zCLI` , Zerops command line tool - `composer`, `git` and `wget`. -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more run.prepareCommands commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more `run.prepareCommands` commands to your `zerops.yml`. When the first deploy with a defined `prepareCommands` attribute is triggered, Zerops will @@ -41,7 +41,7 @@ The prepare runtime container is automatically deleted after the prepare runtime Some packages or tools can take a long time to install. Therefore, Zerops caches your custom runtime environment after the installation of your custom packages or tools is completed. When the second or following deploy is triggered, Zerops will use the custom runtime cache from the previous deploy if following conditions are met: -1. Content of the build.addToRunPrepare and run.prepareCommands attributes didn't change from the previous deploy +1. Content of the `build.addToRunPrepare` and `run.prepareCommands` attributes didn't change from the previous deploy 2. The custom runtime cache wasn't invalidated in the Zerops GUI. To invalidate the custom runtime cache go to `yyy` diff --git a/apps/docs/content/nginx/how-to/customize-web-server.mdx b/apps/docs/content/nginx/how-to/customize-web-server.mdx index 504f383e..f46b3754 100644 --- a/apps/docs/content/nginx/how-to/customize-web-server.mdx +++ b/apps/docs/content/nginx/how-to/customize-web-server.mdx @@ -25,7 +25,7 @@ server { The configuration contains 2 variables: -- **`{{.DocumentRoot}}`** is replaced by the run.documentRoot attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. +- **`{{.DocumentRoot}}`** is replaced by the `run.documentRoot` attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. ## Customize Nginx configuration @@ -35,7 +35,7 @@ Follow these steps to customize the Nginx configuration in Nginx static service: 2. Optionally use following variables: -- **`{{.DocumentRoot}}`** is replaced by the run.documentRoot attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. +- **`{{.DocumentRoot}}`** is replaced by the `run.documentRoot` attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. Example: @@ -52,10 +52,10 @@ Use the **.tmpl** file extension to make Zerops interpret the file as a template 3. Check that your Nginx configuration is consistent with Zerops requirements: - Do not use IP addresses in the `listen` directive -- If you use other ports than `:80` in the `listen` directive, add them to the run.ports in your `zerops.yml` as well. +- If you use other ports than `:80` in the `listen` directive, add them to the `run.ports` in your `zerops.yml` as well. - Do not use the port **:443**. All the incoming `https://` traffic is terminated on the Zerops internal balancer where the SSL certificate is installed and the request is forwarded to your Nginx static service as a **http://** on the port **:80**. -4. Add the siteConfigPath to the run section of your `zerops.yml` +4. Add the `siteConfigPath` to the run section of your `zerops.yml` ```yml zerops: @@ -80,6 +80,6 @@ zerops: siteConfigPath: site_config.tmpl ``` -5. Ensure that the build.deployFiles contains the folder with the `siteConfigPath` or add the path to the Nginx config file to the `deployFiles` list. Zerops will deploy the file to the runtime container(s). +5. Ensure that the `build.deployFiles` contains the folder with the `siteConfigPath` or add the path to the Nginx config file to the `deployFiles` list. Zerops will deploy the file to the runtime container(s). 6. [Trigger](/nginx/how-to/trigger-pipeline) the build & deploy pipeline. diff --git a/apps/docs/content/nginx/how-to/deploy-process.mdx b/apps/docs/content/nginx/how-to/deploy-process.mdx index 407a8a84..7090efc6 100644 --- a/apps/docs/content/nginx/how-to/deploy-process.mdx +++ b/apps/docs/content/nginx/how-to/deploy-process.mdx @@ -37,11 +37,11 @@ Zerops performs following actions for each new container: Services with multiple containers are deployed in parallel. :::info -If your application needs to be initialized in each runtime container, add [init commands](/nginx/how-to/build-pipeline#initcommands) to zerops.yml. +If your application needs to be initialized in each runtime container, add [init commands](/nginx/how-to/build-pipeline#initcommands) to `zerops.yml`. ::: :::caution -Do not use the initCommands for customising your runtime environment. See [how to customise the runtime environment](/nginx/how-to/deploy-process#customise-nginx-runtime-environment). +Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/nginx/how-to/deploy-process#customise-nginx-runtime-environment). ::: ## Further deploys @@ -68,9 +68,9 @@ Application in the runtime container with a pending readiness check won't receiv If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy. -The httpGet readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. +The `httpGet` readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. -The exec.command readiness check is successful when the command returns status code 0. The timeout is 5 seconds. +The `exec.command` readiness check is successful when the command returns status code 0. The timeout is 5 seconds. Read the [runtime log](/nginx/how-to/logs#runtime-log) to troubleshoot failed readiness checks. diff --git a/apps/docs/content/nginx/how-to/trigger-pipeline.mdx b/apps/docs/content/nginx/how-to/trigger-pipeline.mdx index db94e1d7..337310c6 100644 --- a/apps/docs/content/nginx/how-to/trigger-pipeline.mdx +++ b/apps/docs/content/nginx/how-to/trigger-pipeline.mdx @@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t

:::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ### Skip the automatic pipeline once @@ -60,7 +60,7 @@ To start a new build & deploy pipeline manually, use the Zerops CLI. Follow these steps: -1. Add zerops.yml to your repository. +1. Add `zerops.yml` to your repository. 2. [Install & setup zCLI](/references/cli) the Zerops command line tool. 3. Run `zcli push` command. @@ -96,7 +96,7 @@ Flags: zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from. :::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ## Manual deploy using Zerops CLI @@ -138,5 +138,5 @@ Flags: `zerops.yml` must be placed in the working directory. :::info -You can change the deploy pipeline when you need to. Just simply modify the zerops.yml in your working directory. +You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory. ::: diff --git a/apps/docs/content/nginx/how-to/upgrade.mdx b/apps/docs/content/nginx/how-to/upgrade.mdx index 47d09f16..d0f9ea9f 100644 --- a/apps/docs/content/nginx/how-to/upgrade.mdx +++ b/apps/docs/content/nginx/how-to/upgrade.mdx @@ -2,4 +2,4 @@ title: How to upgrade the Nginx version --- -You can upgrade or downgrade your Nginx static service to a different major Nginx version by setting the run.base parameter in your `zerops.yml`. When you [trigger a new pipeline](/nginx/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Nginx version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Nginx version for your runtime. +You can upgrade or downgrade your Nginx static service to a different major Nginx version by setting the `run.base` parameter in your `zerops.yml`. When you [trigger a new pipeline](/nginx/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Nginx version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Nginx version for your runtime. diff --git a/apps/docs/content/nginx/tutorial/quickstart.mdx b/apps/docs/content/nginx/tutorial/quickstart.mdx index ecb6d63e..0c8bde55 100644 --- a/apps/docs/content/nginx/tutorial/quickstart.mdx +++ b/apps/docs/content/nginx/tutorial/quickstart.mdx @@ -29,7 +29,7 @@ services: **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://helloworld-24-8080.prg1.zerops.app`. -2. Click or the subdomain URL to open it in a browser and you should see +2. Click or the `subdomain` URL to open it in a browser and you should see ``` Hello, World! diff --git a/apps/docs/content/nginx/tutorial/runtime-sql.mdx b/apps/docs/content/nginx/tutorial/runtime-sql.mdx index 5cb784da..afbffdee 100644 --- a/apps/docs/content/nginx/tutorial/runtime-sql.mdx +++ b/apps/docs/content/nginx/tutorial/runtime-sql.mdx @@ -32,7 +32,7 @@ In the detail of each step, you can find a link with more information about the
3. In the left menu, click on Import services, copy & paste the - contents of the import-services.yml config file from the recipe + contents of the `import-services.yml` config file from the recipe repository of your choice. Then click on Import service.

@@ -45,7 +45,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -75,7 +75,7 @@ Learn more about how to access build log<

- 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 + 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

`Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1`

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. @@ -86,14 +86,14 @@ For now, check out other features, such as

- 7. One of the services is adminer, a database management tool. + 7. One of the services is `adminer`, a database management tool. See how to{' '} access it.

Learn more about how to{' '} - use psql + use `psql` {' '} command-line tool instead or how to{' '} import and export data{' '} diff --git a/apps/docs/content/nginx/tutorial/step-by-step.mdx b/apps/docs/content/nginx/tutorial/step-by-step.mdx index b406cc9a..1979f29f 100644 --- a/apps/docs/content/nginx/tutorial/step-by-step.mdx +++ b/apps/docs/content/nginx/tutorial/step-by-step.mdx @@ -48,7 +48,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -78,7 +78,7 @@ Learn more about how to access build log<

- 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with Hello World! printed. + 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with `Hello World!` printed.

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. diff --git a/apps/docs/content/nodejs/how-to/access.mdx b/apps/docs/content/nodejs/how-to/access.mdx index f60b15e0..fc6dc699 100644 --- a/apps/docs/content/nodejs/how-to/access.mdx +++ b/apps/docs/content/nodejs/how-to/access.mdx @@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers To connect to your application with `app` hostname running on [internal port](/nodejs/how-to/build-pipeline#ports) `3000`, simply use `http://app:3000` :::info -Do not use https:// when communicating with Node.js from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Node.js from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. ::: ### Use Node.js environment variables @@ -41,12 +41,12 @@ You can securely connect to your Node.js application from your local workspace v Once the VPN session is established, you have the secured connection to the project's private network in Zerops. You can access all project services locally by using their hostname. The only difference is that no [environment variables](/nodejs/how-to/env-variables) are available when connected through VPN. To connect to your Node.js application in Zerops set the hostname and [internal port](/nodejs/how-to/build-pipeline#ports) e.g. http://app:3000 :::info -Do not use https:// when communicating with Node.js over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Node.js over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. ::: ### Connect via SSH -Use the ssh command to connect to your service via SSH. +Use the `ssh` command to connect to your service via SSH. ### Stop VPN connection diff --git a/apps/docs/content/nodejs/how-to/build-pipeline.mdx b/apps/docs/content/nodejs/how-to/build-pipeline.mdx index 68ac2541..c6620f06 100644 --- a/apps/docs/content/nodejs/how-to/build-pipeline.mdx +++ b/apps/docs/content/nodejs/how-to/build-pipeline.mdx @@ -117,8 +117,8 @@ zerops:

The base build environment contains {data.alpineCurrentVersion}, the selected major version of Node.js,{' '} - Zerops command line tool, npm,{' '} - yarn, git and npx tools. + Zerops command line tool, `npm`,{' '} + `yarn`, `git` and `npx` tools.

:::info @@ -293,7 +293,7 @@ If the command ends successfully, it returns the exit code 0 and Zerops triggers ### 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. +_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. ```yml # REQUIRED. Select which files / folders to deploy after @@ -356,7 +356,7 @@ deployFiles: ./path/~/to/ #### .deployignore -Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a .gitignore file. +Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a `.gitignore` file. Example to ignore `node_modules` folder in deploy: @@ -372,7 +372,7 @@ node_modules; ``` :::note -`.deployignore` file also works with zcli service deploy command. +`.deployignore` file also works with `zcli service deploy` command. ::: ### cache @@ -446,8 +446,8 @@ zerops:

The base runtime environment contains {data.alpineCurrentVersion}, the - selected major version of Node.js, Zerops command line tool, npm,{' '} - yarn, git and npx tools. + selected major version of Node.js, Zerops command line tool, `npm`,{' '} + `yarn`, `git` and `npx` tools.

:::info @@ -522,8 +522,8 @@ _OPTIONAL._ Customises the Node.js runtime environment by installing additional

The base Node.js environment contains {data.alpineCurrentVersion} the selected major version of Node.js,{' '} - Zerops command line tool and npm,{' '} - yarn, git and npx tools. To install + Zerops command line tool and `npm`,{' '} + `yarn`, `git` and `npx` tools. To install additional packages or tools add one or more prepare commands:

@@ -577,8 +577,8 @@ You can configure your prepare commands to be run in a single shell instance or

The prepare runtime container contains {data.alpineCurrentVersion}, the selected major version of Node.js,{' '} - Zerops command line tool and npm,{' '} - yarn, git and npx tools. + Zerops command line tool and `npm`,{' '} + `yarn`, `git` and `npx` tools.

The prepare runtime container does not contain your application code nor the built application. If you need to copy some folders or files from the build container to the runtime container (e.g. a configuration file) use the `addToRunPrepare` attribute in the [build section](#build-pipeline-configuration). diff --git a/apps/docs/content/nodejs/how-to/build-process.mdx b/apps/docs/content/nodejs/how-to/build-process.mdx index 8d697ff7..1a34aa7e 100644 --- a/apps/docs/content/nodejs/how-to/build-process.mdx +++ b/apps/docs/content/nodejs/how-to/build-process.mdx @@ -53,7 +53,7 @@ The default Node.js build environment contains: - [zCLI](/references/cli), Zerops command line tool - `npm`, `yarn`, `git` and `npx` tools -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/nodejs/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/nodejs/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. :::info The application code is available in the `/var/www` folder in your build container before the prepare commands are triggered. This allows you to use any file from your application code in your prepare commands (e.g. a configuration file). diff --git a/apps/docs/content/nodejs/how-to/create.mdx b/apps/docs/content/nodejs/how-to/create.mdx index b791d7c3..38706e27 100644 --- a/apps/docs/content/nodejs/how-to/create.mdx +++ b/apps/docs/content/nodejs/how-to/create.mdx @@ -278,7 +278,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -293,16 +293,16 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type nodejs and version. + Specifies the service type `nodejs` and version.
Set type:{' '} - + ` nodejs@<version> - {' '} + `{' '} or{' '} - + ` nodejs@latest - + `

Limitations: @@ -330,8 +330,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/nodejs/how-to/customize-runtime.mdx b/apps/docs/content/nodejs/how-to/customize-runtime.mdx index cdd01ff3..17aabfb1 100644 --- a/apps/docs/content/nodejs/how-to/customize-runtime.mdx +++ b/apps/docs/content/nodejs/how-to/customize-runtime.mdx @@ -18,12 +18,12 @@ The default Node.js runtime environment contains: - {data.alpineCurrentVersion} - selected version of Node.js selected when the runtime service was created. - - zCLI + `zCLI` , Zerops command line tool - `npm`, `yarn`, `git` and `npx` tools -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more run.prepareCommands commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more `run.prepareCommands` commands to your `zerops.yml`. When the first deploy with a defined `prepareCommands` attribute is triggered, Zerops will @@ -41,7 +41,7 @@ The prepare runtime container is automatically deleted after the prepare runtime Some packages or tools can take a long time to install. Therefore, Zerops caches your custom runtime environment after the installation of your custom packages or tools is completed. When the second or following deploy is triggered, Zerops will use the custom runtime cache from the previous deploy if following conditions are met: -1. Content of the build.addToRunPrepare and run.prepareCommands attributes didn't change from the previous deploy +1. Content of the `build.addToRunPrepare` and `run.prepareCommands` attributes didn't change from the previous deploy 2. The custom runtime cache wasn't invalidated in the Zerops GUI. To invalidate the custom runtime cache go to `yyy` diff --git a/apps/docs/content/nodejs/how-to/deploy-process.mdx b/apps/docs/content/nodejs/how-to/deploy-process.mdx index f84e6aab..bfa427dc 100644 --- a/apps/docs/content/nodejs/how-to/deploy-process.mdx +++ b/apps/docs/content/nodejs/how-to/deploy-process.mdx @@ -39,11 +39,11 @@ Zerops performs following actions for each new container: Services with multiple containers are deployed in parallel. :::info -If your application needs to be initialized in each runtime container, add [init commands](/nodejs/how-to/build-pipeline#initcommands) to zerops.yml. +If your application needs to be initialized in each runtime container, add [init commands](/nodejs/how-to/build-pipeline#initcommands) to `zerops.yml`. ::: :::caution -Do not use the initCommands for customising your runtime environment. See [how to customise the runtime environment](/nodejs/how-to/build-pipeline#preparecommands-1). +Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/nodejs/how-to/build-pipeline#preparecommands-1). ::: ## Further deploys @@ -70,9 +70,9 @@ Application in the runtime container with a pending readiness check won't receiv If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy. -The httpGet readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. +The `httpGet` readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. -The exec.command readiness check is successful when the command returns status code 0. The timeout is 5 seconds. +The `exec.command` readiness check is successful when the command returns status code 0. The timeout is 5 seconds. Read the [runtime log](/nodejs/how-to/logs#runtime-log) to troubleshoot failed readiness checks. diff --git a/apps/docs/content/nodejs/how-to/logs.mdx b/apps/docs/content/nodejs/how-to/logs.mdx index 7c50624a..dfee2c00 100644 --- a/apps/docs/content/nodejs/how-to/logs.mdx +++ b/apps/docs/content/nodejs/how-to/logs.mdx @@ -93,9 +93,9 @@ console.log('<7>Debug (7) severity > debug-level message.'); :::info -console.info, console.warn, console.debug -, and console.error are just aliases to the +`console.info`, `console.warn`, `console.debug` +, and `console.error` are just aliases to the ` console.log - method. They don't set the appropriate severity number. Use the +` method. They don't set the appropriate severity number. Use the ` <N> - prefix instead. ::: +` prefix instead. ::: diff --git a/apps/docs/content/nodejs/how-to/trigger-pipeline.mdx b/apps/docs/content/nodejs/how-to/trigger-pipeline.mdx index ba7a0599..32e41c92 100644 --- a/apps/docs/content/nodejs/how-to/trigger-pipeline.mdx +++ b/apps/docs/content/nodejs/how-to/trigger-pipeline.mdx @@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t

:::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ### Skip the automatic pipeline once @@ -60,7 +60,7 @@ To start a new build & deploy pipeline manually, use the Zerops CLI. Follow these steps: -1. Add zerops.yml to your repository. +1. Add `zerops.yml` to your repository. 2. [Install & setup zCLI](/references/cli) the Zerops command line tool. 3. Run `zcli push` command. @@ -96,7 +96,7 @@ Flags: zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from. :::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ## Manual deploy using Zerops CLI @@ -138,5 +138,5 @@ Flags: `zerops.yml` must be placed in the working directory. :::info -You can change the deploy pipeline when you need to. Just simply modify the zerops.yml in your working directory. +You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory. ::: diff --git a/apps/docs/content/nodejs/how-to/upgrade.mdx b/apps/docs/content/nodejs/how-to/upgrade.mdx index dd57a313..45225010 100644 --- a/apps/docs/content/nodejs/how-to/upgrade.mdx +++ b/apps/docs/content/nodejs/how-to/upgrade.mdx @@ -2,6 +2,6 @@ title: How to upgrade the Node.js version --- -You can upgrade or downgrade your Node.js service to a different major Node.js version by setting the run.base parameter in your `zerops.yml`. When you [trigger a new pipeline](/nodejs/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Node.js version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Node.js version for your runtime. +You can upgrade or downgrade your Node.js service to a different major Node.js version by setting the `run.base` parameter in your `zerops.yml`. When you [trigger a new pipeline](/nodejs/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Node.js version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Node.js version for your runtime. -If you want to build your application with a different major Node.js version, change the build.base parameter in your `zerops.yml`. The `build.base` is the required attribute. +If you want to build your application with a different major Node.js version, change the `build.base` parameter in your `zerops.yml`. The `build.base` is the required attribute. diff --git a/apps/docs/content/nodejs/tutorial/quickstart.mdx b/apps/docs/content/nodejs/tutorial/quickstart.mdx index e5d1c1c1..baec54a8 100644 --- a/apps/docs/content/nodejs/tutorial/quickstart.mdx +++ b/apps/docs/content/nodejs/tutorial/quickstart.mdx @@ -29,7 +29,7 @@ services: **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://helloworld-24-8080.prg1.zerops.app`. -2. Click or the subdomain URL to open it in a browser and you should see +2. Click or the `subdomain` URL to open it in a browser and you should see ``` Hello, World! diff --git a/apps/docs/content/nodejs/tutorial/runtime-sql.mdx b/apps/docs/content/nodejs/tutorial/runtime-sql.mdx index 28d1f1ab..b50349d1 100644 --- a/apps/docs/content/nodejs/tutorial/runtime-sql.mdx +++ b/apps/docs/content/nodejs/tutorial/runtime-sql.mdx @@ -32,7 +32,7 @@ In the detail of each step, you can find a link with more information about the
3. In the left menu, click on Import services, copy & paste the - contents of the import-services.yml config file from the recipe + contents of the `import-services.yml` config file from the recipe repository of your choice. Then click on Import service.

@@ -45,7 +45,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -75,7 +75,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 + 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

`Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1`

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. @@ -86,14 +86,14 @@ For now, check out other features, such as access it.

Learn more about how to{' '} - use psql + use `psql` {' '} command-line tool instead or how to{' '} import and export data{' '} diff --git a/apps/docs/content/nodejs/tutorial/step-by-step.mdx b/apps/docs/content/nodejs/tutorial/step-by-step.mdx index e5c77387..fcefb38a 100644 --- a/apps/docs/content/nodejs/tutorial/step-by-step.mdx +++ b/apps/docs/content/nodejs/tutorial/step-by-step.mdx @@ -48,7 +48,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -78,7 +78,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with Hello World! printed. + 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with `Hello World!` printed.

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. diff --git a/apps/docs/content/object-storage/how-to/create.mdx b/apps/docs/content/object-storage/how-to/create.mdx index 2c349456..fc3bf30f 100644 --- a/apps/docs/content/object-storage/how-to/create.mdx +++ b/apps/docs/content/object-storage/how-to/create.mdx @@ -54,10 +54,10 @@ Select one of the basic policy templates: | Template | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Public read | Allows anyone:

  • to read the bucket's location (s3:GetBucketLocation)
  • to list all bucket's objects (s3:ListBucket)
  • to get any object of the bucket (s3:GetObject)
| -| Public objects read | Allows anyone:
  • to read the bucket's location (s3:GetBucketLocation)
  • to get any object of the bucket (s3:GetObject)
| -| Public read write | Allows anyone:
  • to read the bucket's location (s3:GetBucketLocation)
  • to list all bucket's objects (s3:ListBucket)
  • to get any object of the bucket (s3:GetObject)
  • to create a new object in the bucket (s3:PutObject,s3:ListMultipartUploadParts, s3:AbortMultipartUpload, s3:ListBucketMultipartUploads)
  • to delete any object of the bucket (s3:DeleteObject)
| -| Public write | Allows anyone to create objects in the bucket (PutObject action) | +| Public read | Allows anyone:
  • to read the bucket's location `(s3:GetBucketLocation)`
  • to list all bucket's objects `(s3:ListBucket)`
  • to get any object of the bucket `(s3:GetObject)`
| +| Public objects read | Allows anyone:
  • to read the bucket's location `(s3:GetBucketLocation)`
  • to get any object of the bucket `(s3:GetObject)`
| +| Public read write | Allows anyone:
  • to read the bucket's location `(s3:GetBucketLocation)`
  • to list all bucket's objects `(s3:ListBucket)`
  • to get any object of the bucket `(s3:GetObject)`
  • to create a new object in the bucket `(s3:PutObject,s3:ListMultipartUploadParts, s3:AbortMultipartUpload, s3:ListBucketMultipartUploads)`
  • to delete any object of the bucket `(s3:DeleteObject)`
| +| Public write | Allows anyone to create objects in the bucket `(PutObject action)` | | Private | Denies the access to unauthenticated users. | Or you can set your own access policy in the [IAM Policy JSON format](https://min.io/docs/minio/linux/administration/identity-access-management/policy-based-access-control.html#policy-document-structure). @@ -171,7 +171,7 @@ At least one service in `services:` section is required. You can create a projec | **hostname** | The unique service identifier.
The name of the new Object storage will be set to the hostname value.
**Limitations:**
  • duplicate services with the same name in the same project are forbidden
  • maximum 25 characters
  • must contain only lowercase ASCII letters (a-z) or numbers (0-9)
| | **type** | Specifies the Object storage type objectstorage and version.
Set type: `objectstorage`
**Limitations:** Currently `objectstorage` or `object-storage` is available. | | **objectStorageSize** | The size of the bucket quota in GB.
**Limitations:** Set a whole number between 1 and 100. | -| **objectStoragePolicy** | **Optional.** Either `objectStoragePolicy` or `objectStorageRawPolicy` is required.
Set one of allowed values:
  • public-read
  • public-objects-read
  • public-read-write
  • public-write
  • private
Read more about [the basic policy templates]. | +| **objectStoragePolicy** | **Optional.** Either `objectStoragePolicy` or `objectStorageRawPolicy` is required.
Set one of allowed values:
  • `public-read`
  • `public-objects-read`
  • `public-read-write`
  • `public-write`
  • `private`
Read more about [the basic policy templates]. | | **objectStorageRawPolicy** | **Optional.** Either `objectStoragePolicy` or `objectStorageRawPolicy` is required.
Set your own access policy in the [IAM Policy JSON format].
The `{{ .BucketName }}` variable will be replaced by the bucket name. | Zerops creates one bucket automatically for each new Object storage service. diff --git a/apps/docs/content/object-storage/how-to/update-bucket.mdx b/apps/docs/content/object-storage/how-to/update-bucket.mdx index 3ada34b0..0b50625a 100644 --- a/apps/docs/content/object-storage/how-to/update-bucket.mdx +++ b/apps/docs/content/object-storage/how-to/update-bucket.mdx @@ -41,10 +41,10 @@ Select one of the basic policy templates: | Template | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Public read | Allows anyone:
  • to read the bucket's location (s3:GetBucketLocation)
  • to list all bucket's objects (s3:ListBucket)
  • to get any object of the bucket (s3:GetObject)
| -| Public objects read | Allows anyone:
  • to read the bucket's location (s3:GetBucketLocation)
  • to get any object of the bucket (s3:GetObject)
| -| Public read write | Allows anyone:
  • to read the bucket's location (s3:GetBucketLocation)
  • to list all bucket's objects (s3:ListBucket)
  • to get any object of the bucket (s3:GetObject)
  • to create a new object in the bucket (s3:PutObject,s3:ListMultipartUploadParts, s3:AbortMultipartUpload, s3:ListBucketMultipartUploads)
  • to delete any object of the bucket (s3:DeleteObject)
| -| Public write | Allows anyone to create objects in the bucket (PutObject action) | +| Public read | Allows anyone:
  • to read the bucket's location `(s3:GetBucketLocation)`
  • to list all bucket's objects `(s3:ListBucket)`
  • to get any object of the bucket `(s3:GetObject)`
| +| Public objects read | Allows anyone:
  • to read the bucket's location `(s3:GetBucketLocation)`
  • to get any object of the bucket `(s3:GetObject)`
| +| Public read write | Allows anyone:
  • to read the bucket's location `(s3:GetBucketLocation)`
  • to list all bucket's objects `(s3:ListBucket)`
  • to get any object of the bucket `(s3:GetObject)`
  • to create a new object in the bucket `(s3:PutObject,s3:ListMultipartUploadParts, s3:AbortMultipartUpload, s3:ListBucketMultipartUploads)`
  • to delete any object of the bucket `(s3:DeleteObject)`
| +| Public write | Allows anyone to create objects in the bucket `(PutObject action)` | | Private | Denies the access to unauthenticated users. | Or you can set your own access policy in the [IAM Policy JSON format](https://min.io/docs/minio/linux/administration/identity-access-management/policy-based-access-control.html#policy-document-structure). diff --git a/apps/docs/content/php/how-to/access.mdx b/apps/docs/content/php/how-to/access.mdx index c6608947..c0cb1760 100644 --- a/apps/docs/content/php/how-to/access.mdx +++ b/apps/docs/content/php/how-to/access.mdx @@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers To connect to your application with `app` hostname running on [internal port](/php/how-to/build-pipeline#ports) `80`, simply use `http://app:80` :::info -Do not use https:// when communicating with PHP from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with PHP from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. ::: ### Use PHP environment variables @@ -41,12 +41,12 @@ You can securely connect to your PHP application from your local workspace via Z Once the VPN session is established, you have the secured connection to the project's private network in Zerops. You can access all project services locally by using their hostname. The only difference is that no [environment variables](/php/how-to/env-variables) are available when connected through VPN. To connect to your PHP application in Zerops set the hostname and [internal port](/php/how-to/build-pipeline#ports) e.g. http://app:80 :::info -Do not use https:// when communicating with PHP over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with PHP over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. ::: ### Connect via SSH -Use the ssh command to connect to your service via SSH. +Use the `ssh` command to connect to your service via SSH. ### Stop VPN connection diff --git a/apps/docs/content/php/how-to/build-pipeline.mdx b/apps/docs/content/php/how-to/build-pipeline.mdx index 2219983a..6a615684 100644 --- a/apps/docs/content/php/how-to/build-pipeline.mdx +++ b/apps/docs/content/php/how-to/build-pipeline.mdx @@ -115,7 +115,7 @@ zerops:

The base build environment contains {data.alpineCurrentVersion}, the selected major version of PHP, Zerops command line tool,{' '} - composer, git and wget. + `composer`, `git` and `wget`.

:::info @@ -288,7 +288,7 @@ If the command ends successfully, it returns the exit code 0 and Zerops triggers ### 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. +_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. ```yml # REQUIRED. Select which files / folders to deploy after @@ -350,7 +350,7 @@ deployFiles: ./path/~/to/ #### .deployignore -Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a .gitignore file. +Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a `.gitignore` file. Example to ignore `src/file.txt` file in deploy: @@ -366,7 +366,7 @@ src / file.txt; ``` :::note -`.deployignore` file also works with zcli service deploy command. +`.deployignore` file also works with `zcli service deploy` command. ::: ### cache @@ -442,7 +442,7 @@ zerops: The base runtime environment contains {data.alpineCurrentVersion}, the selected major version of PHP,{' '} Zerops command line tool and{' '} - composer, git and wget. + `composer`, `git` and `wget`.

:::info @@ -529,7 +529,7 @@ _OPTIONAL._ Customises the PHP runtime environment by installing additional depe

The base PHP environment contains {data.alpineCurrentVersion}, the selected major version of PHP, Zerops command line tool{' '} - and composer, git and wget. To install + and `composer`, `git` and `wget`. To install additional packages or tools add one or more prepare commands:

@@ -591,7 +591,7 @@ You can configure your prepare commands to be run in a single shell instance or The prepare runtime container contains {data.alpineCurrentVersion}, the selected major version of PHP,{' '} Zerops command line tool and{' '} - composer, git and wget. + `composer`, `git` and `wget`.

The prepare runtime container does not contain your application code nor the built application. If you need to copy some folders or files from the build container to the runtime container (e.g. a configuration file) use the `addToRunPrepare` attribute in the [build section](#build-pipeline-configuration). diff --git a/apps/docs/content/php/how-to/build-process.mdx b/apps/docs/content/php/how-to/build-process.mdx index fc0b443d..92665ff5 100644 --- a/apps/docs/content/php/how-to/build-process.mdx +++ b/apps/docs/content/php/how-to/build-process.mdx @@ -44,7 +44,7 @@ The default PHP build environment contains: - [zCLI](/references/cli), Zerops command line tool - `composer`, `git` and `wget`. -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/php/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/php/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. :::info The application code is available in the `/var/www` folder in your build container before the prepare commands are triggered. This allows you to use any file from your application code in your prepare commands (e.g. a configuration file). diff --git a/apps/docs/content/php/how-to/create.mdx b/apps/docs/content/php/how-to/create.mdx index c1e57b16..9a090119 100644 --- a/apps/docs/content/php/how-to/create.mdx +++ b/apps/docs/content/php/how-to/create.mdx @@ -268,7 +268,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -283,25 +283,25 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type php-apache or{' '} - php-nginx and version. + Specifies the service type `php-apache` or{' '} + `php-nginx` and version.
Set type:{' '} - + ` php-apache@<version> - + ` ,{' '} - + ` php-nginx@<version> - + ` ,{' '} - + ` php-apache@latest - {' '} + `{' '} or{' '} - + ` php-nginx@latest - + `

Limitations: @@ -329,8 +329,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/php/how-to/customize-runtime.mdx b/apps/docs/content/php/how-to/customize-runtime.mdx index e7a87bf5..40030613 100644 --- a/apps/docs/content/php/how-to/customize-runtime.mdx +++ b/apps/docs/content/php/how-to/customize-runtime.mdx @@ -18,12 +18,12 @@ The default PHP runtime environment contains: - {data.alpineCurrentVersion} - selected version of PHP selected when the runtime service was created. - - zCLI + `zCLI` , Zerops command line tool - `composer`, `git` and `wget`. -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more run.prepareCommands commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more `run.prepareCommands` commands to your `zerops.yml`. When the first deploy with a defined `prepareCommands` attribute is triggered, Zerops will @@ -41,7 +41,7 @@ The prepare runtime container is automatically deleted after the prepare runtime Some packages or tools can take a long time to install. Therefore, Zerops caches your custom runtime environment after the installation of your custom packages or tools is completed. When the second or following deploy is triggered, Zerops will use the custom runtime cache from the previous deploy if following conditions are met: -1. Content of the build.addToRunPrepare and run.prepareCommands attributes didn't change from the previous deploy +1. Content of the `build.addToRunPrepare` and `run.prepareCommands` attributes didn't change from the previous deploy 2. The custom runtime cache wasn't invalidated in the Zerops GUI. To invalidate the custom runtime cache go to `yyy` diff --git a/apps/docs/content/php/how-to/customize-web-server.mdx b/apps/docs/content/php/how-to/customize-web-server.mdx index 7fd3ae81..936c1351 100644 --- a/apps/docs/content/php/how-to/customize-web-server.mdx +++ b/apps/docs/content/php/how-to/customize-web-server.mdx @@ -44,7 +44,7 @@ server { The configuration contains 2 variables: -- **`{{.DocumentRoot}}`** is replaced by the run.documentRoot attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. +- **`{{.DocumentRoot}}`** is replaced by the `run.documentRoot` attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. - **`{{.PhpSocket}}`** is replaced by a path to the PHP socket based on the PHP version. @@ -56,7 +56,7 @@ Follow these steps to customize the Nginx configuration in PHP+Nginx service: 2. Optionally use following variables: -- **`{{.DocumentRoot}}`** is replaced by the run.documentRoot attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. +- **`{{.DocumentRoot}}`** is replaced by the `run.documentRoot` attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. Example: @@ -81,10 +81,10 @@ Use the **.tmpl** file extension to make Zerops interpret the file as a template 3. Check that your Nginx configuration is consistent with Zerops requirements: - Do not use IP addresses in the `listen` directive -- If you use other ports than `:80` in the `listen` directive, add them to the run.ports in your `zerops.yml` as well. +- If you use other ports than `:80` in the `listen` directive, add them to the `run.ports` in your `zerops.yml` as well. - Do not use the port **:443**. All the incoming `https://` traffic is terminated on the Zerops internal balancer where the SSL certificate is installed and the request is forwarded to your PHP+Nginx service as a **http://** on the port **:80**. -4. Add the siteConfigPath to the run section of your `zerops.yml` +4. Add the `siteConfigPath` to the run section of your `zerops.yml` ```yml zerops: @@ -109,7 +109,7 @@ zerops: siteConfigPath: site_config.tmpl ``` -5. Ensure that the build.deployFiles contains the folder with the `siteConfigPath` or add the path to the Nginx config file to the `deployFiles` list. Zerops will deploy the file to the runtime container(s). +5. Ensure that the `build.deployFiles` contains the folder with the `siteConfigPath` or add the path to the Nginx config file to the `deployFiles` list. Zerops will deploy the file to the runtime container(s). 6. [Trigger](<(/php/how-to/trigger-pipeline)>) the build & deploy pipeline. @@ -143,7 +143,7 @@ The default PHP+Apache service has following Apache configuration: The configuration contains 2 variables: -- **`{{.DocumentRoot}}`** is replaced by the run.documentRoot attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. +- **`{{.DocumentRoot}}`** is replaced by the `run.documentRoot` attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. - **`{{.PhpSocket}}`** is replaced by a path to the PHP socket based on the PHP version. @@ -155,7 +155,7 @@ Follow these steps to customize the Apache configuration in PHP+Apache service: 2. Optionally use following variables: -- **`{{.DocumentRoot}}`** is replaced by the run.documentRoot attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. +- **`{{.DocumentRoot}}`** is replaced by the `run.documentRoot` attribute from the `zerops.yml`. If the attribute is not specified, the default value `/var/www` is used. Example: @@ -182,10 +182,10 @@ Use the **.tmpl** file extension to make Zerops interpret the file as a template 3. Check that your Apache configuration is consistent with Zerops requirements: - Do not use IP addresses in the `` directive -- If you use other ports than `:80` in the `` directive, add them to the run.ports in your `zerops.yml` as well. +- If you use other ports than `:80` in the `` directive, add them to the `run.ports` in your `zerops.yml` as well. Do not use the port **:443**. All the incoming `https://` traffic is terminated on the Zerops internal balancer where the SSL certificate is installed and the request is forwarded to your PHP+Apache service as a **http://** on the port **:80**. -4. Add the siteConfigPath to the run section of your `zerops.yml`. +4. Add the `siteConfigPath` to the run section of your `zerops.yml`. ```yml zerops: @@ -210,6 +210,6 @@ zerops: siteConfigPath: site_config.tmpl ``` -5. Ensure that the build.deployFiles contains the folder with the `siteConfigPath` or add the path to the Apache config file to the `deployFiles` list. Zerops will deploy the file to the runtime container(s). +5. Ensure that the `build.deployFiles` contains the folder with the `siteConfigPath` or add the path to the Apache config file to the `deployFiles` list. Zerops will deploy the file to the runtime container(s). 6. [Trigger](/php/how-to/trigger-pipeline) the build & deploy pipeline. diff --git a/apps/docs/content/php/how-to/deploy-process.mdx b/apps/docs/content/php/how-to/deploy-process.mdx index 3930c67a..fba4e179 100644 --- a/apps/docs/content/php/how-to/deploy-process.mdx +++ b/apps/docs/content/php/how-to/deploy-process.mdx @@ -39,11 +39,11 @@ Zerops performs following actions for each new container: Services with multiple containers are deployed in parallel. :::info -If your application needs to be initialized in each runtime container, add [init commands](/php/how-to/build-pipeline#initcommands) to zerops.yml. +If your application needs to be initialized in each runtime container, add [init commands](/php/how-to/build-pipeline#initcommands) to `zerops.yml`. ::: :::caution -Do not use the initCommands for customising your runtime environment. See [how to customise the runtime environment](/php/how-to/deploy-process#customise-php-runtime-environment). +Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/php/how-to/deploy-process#customise-php-runtime-environment). ::: ## Further deploys @@ -70,9 +70,9 @@ Application in the runtime container with a pending readiness check won't receiv If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy. -The httpGet readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. +The `httpGet` readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. -The exec.command readiness check is successful when the command returns status code 0. The timeout is 5 seconds. +The `exec.command` readiness check is successful when the command returns status code 0. The timeout is 5 seconds. Read the [runtime log](/php/how-to/logs#runtime-log) to troubleshoot failed readiness checks. diff --git a/apps/docs/content/php/how-to/logs.mdx b/apps/docs/content/php/how-to/logs.mdx index ed4071db..81b5784a 100644 --- a/apps/docs/content/php/how-to/logs.mdx +++ b/apps/docs/content/php/how-to/logs.mdx @@ -88,9 +88,9 @@ console.log('<7>Debug (7) severity > debug-level message.'); :::info -console.info, console.warn, console.debug -, and console.error are just aliases to the +`console.info`, `console.warn`, `console.debug` +, and `console.error` are just aliases to the ` console.log - method. They don't set the appropriate severity number. Use the +` method. They don't set the appropriate severity number. Use the ` <N> - prefix instead. ::: +` prefix instead. ::: diff --git a/apps/docs/content/php/how-to/trigger-pipeline.mdx b/apps/docs/content/php/how-to/trigger-pipeline.mdx index a529d637..401ec3c5 100644 --- a/apps/docs/content/php/how-to/trigger-pipeline.mdx +++ b/apps/docs/content/php/how-to/trigger-pipeline.mdx @@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t

:::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ### Skip the automatic pipeline once @@ -60,7 +60,7 @@ To start a new build & deploy pipeline manually, use the Zerops CLI. Follow these steps: -1. Add zerops.yml to your repository. +1. Add `zerops.yml` to your repository. 2. [Install & setup zCLI](/references/cli) the Zerops command line tool. 3. Run `zcli push` command. @@ -96,7 +96,7 @@ Flags: zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from. :::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ## Manual deploy using Zerops CLI @@ -138,5 +138,5 @@ Flags: `zerops.yml` must be placed in the working directory. :::info -You can change the deploy pipeline when you need to. Just simply modify the zerops.yml in your working directory. +You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory. ::: diff --git a/apps/docs/content/php/how-to/upgrade.mdx b/apps/docs/content/php/how-to/upgrade.mdx index 0ee045e0..06631bef 100644 --- a/apps/docs/content/php/how-to/upgrade.mdx +++ b/apps/docs/content/php/how-to/upgrade.mdx @@ -2,6 +2,6 @@ title: How to upgrade the PHP version --- -You can upgrade or downgrade your PHP service to a different major PHP version by setting the run.base parameter in your `zerops.yml`. When you [trigger a new pipeline](/php/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required PHP version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current PHP version for your runtime. +You can upgrade or downgrade your PHP service to a different major PHP version by setting the `run.base` parameter in your `zerops.yml`. When you [trigger a new pipeline](/php/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required PHP version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current PHP version for your runtime. -If you want to build your application with a different major PHP version, change the build.base parameter in your `zerops.yml`. The `build.base` is the required attribute. +If you want to build your application with a different major PHP version, change the `build.base` parameter in your `zerops.yml`. The `build.base` is the required attribute. diff --git a/apps/docs/content/php/tutorial/quickstart.mdx b/apps/docs/content/php/tutorial/quickstart.mdx index 8be1fc8e..f063da45 100644 --- a/apps/docs/content/php/tutorial/quickstart.mdx +++ b/apps/docs/content/php/tutorial/quickstart.mdx @@ -29,7 +29,7 @@ services: **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://helloworld-24-8080.prg1.zerops.app`. -2. Click or the subdomain URL to open it in a browser and you should see +2. Click or the `subdomain` URL to open it in a browser and you should see ``` Hello, World! diff --git a/apps/docs/content/php/tutorial/runtime-sql.mdx b/apps/docs/content/php/tutorial/runtime-sql.mdx index 1be5ba79..860737c5 100644 --- a/apps/docs/content/php/tutorial/runtime-sql.mdx +++ b/apps/docs/content/php/tutorial/runtime-sql.mdx @@ -32,7 +32,7 @@ In the detail of each step, you can find a link with more information about the
3. In the left menu, click on Import services, copy & paste the - contents of the import-services.yml config file from the recipe + contents of the `import-services.yml` config file from the recipe repository of your choice. Then click on Import service.

@@ -45,7 +45,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -75,7 +75,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 + 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

`Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1`

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. @@ -86,14 +86,14 @@ For now, check out other features, such as e

- 7. One of the services is adminer, a database management tool. + 7. One of the services is `adminer`, a database management tool. See how to{' '} access it.

Learn more about how to{' '} - use psql + use `psql` {' '} command-line tool instead or how to{' '} import and export data{' '} diff --git a/apps/docs/content/php/tutorial/step-by-step.mdx b/apps/docs/content/php/tutorial/step-by-step.mdx index 75d3a80a..107e9638 100644 --- a/apps/docs/content/php/tutorial/step-by-step.mdx +++ b/apps/docs/content/php/tutorial/step-by-step.mdx @@ -48,7 +48,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -78,7 +78,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with Hello World! printed. + 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with `Hello World!` printed.

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. diff --git a/apps/docs/content/postgresql/faq.mdx b/apps/docs/content/postgresql/faq.mdx index 101be984..536a685d 100644 --- a/apps/docs/content/postgresql/faq.mdx +++ b/apps/docs/content/postgresql/faq.mdx @@ -5,17 +5,17 @@ title: Frequently Asked Questions import { FAQ, FAQItem } from '/src/components/Faq'; - - *One of possible causes*:
- The connection string in Zerops always starts with{' '} - postgresql://. While the official PostgreSQL documentation - states that both postgresql:// and postgres://{' '} - URIs are valid, some softwares require the shorter postgres://{' '} - version. To fix that, create your own environment variable with the correct - URI, e.g. when your PostgreSQL service is called db -{' '} - - postgres://`${db_user}`:`${db_password}`@`${db_hostname}`:`${db_port}` - - . + + *One possible cause:*
+ The connection string in Zerops always starts with `postgresql://`. While the official PostgreSQL documentation + states that both `postgresql://` and `postgres://` URIs are valid, some software requires the shorter `postgres://` + version. + + To resolve this, create your own environment variable with the correct URI. For example, if your PostgreSQL service is named `db`, use the following format: + + ``` + postgres://${db_user}:${db_password}@${db_hostname}:${db_port} + ``` + diff --git a/apps/docs/content/postgresql/how-to/create.mdx b/apps/docs/content/postgresql/how-to/create.mdx index 39fcc4db..fecb54aa 100644 --- a/apps/docs/content/postgresql/how-to/create.mdx +++ b/apps/docs/content/postgresql/how-to/create.mdx @@ -211,7 +211,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -226,12 +226,12 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type postgresql and version. + Specifies the service type `postgresql` and version.
Set type:{' '} - + ` postgresql@12 - + `

Limitations: @@ -292,8 +292,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/postgresql/tutorial/quickstart.mdx b/apps/docs/content/postgresql/tutorial/quickstart.mdx index 342a3360..e5c454d6 100644 --- a/apps/docs/content/postgresql/tutorial/quickstart.mdx +++ b/apps/docs/content/postgresql/tutorial/quickstart.mdx @@ -71,7 +71,7 @@ As said, there is no need for coding yet, we have created multiple repositories, **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://golang1-24-8080.prg1.zerops.app`. -2. Click on the subdomain URL to open it in a browser and you should see +2. Click on the `subdomain` URL to open it in a browser and you should see ``` Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 diff --git a/apps/docs/content/python/how-to/access.mdx b/apps/docs/content/python/how-to/access.mdx index 3a3e4e74..feb6690f 100644 --- a/apps/docs/content/python/how-to/access.mdx +++ b/apps/docs/content/python/how-to/access.mdx @@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers To connect to your application with `app` hostname running on [internal port](/python/how-to/build-pipeline#ports) `8000`, simply use `http://app:8000` :::info -Do not use https:// when communicating with Python from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Python from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. ::: ### Use Python environment variables @@ -41,12 +41,12 @@ You can securely connect to your Python application from your local workspace vi Once the VPN session is established, you have the secured connection to the project's private network in Zerops. You can access all project services locally by using their hostname. The only difference is that no [environment variables](/python/how-to/env-variables) are available when connected through VPN. To connect to your Python application in Zerops set the hostname and [internal port](/python/how-to/build-pipeline#ports) e.g. http://app:8000 :::info -Do not use https:// when communicating with Python over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Python over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. ::: ### Connect via SSH -Use the ssh command to connect to your service via SSH. +Use the `ssh` command to connect to your service via SSH. ### Stop VPN connection diff --git a/apps/docs/content/python/how-to/build-pipeline.mdx b/apps/docs/content/python/how-to/build-pipeline.mdx index d70bc71b..463dbf3d 100644 --- a/apps/docs/content/python/how-to/build-pipeline.mdx +++ b/apps/docs/content/python/how-to/build-pipeline.mdx @@ -113,8 +113,8 @@ zerops:

The base build environment contains {data.alpineCurrentVersion}, the selected major version of Python,{' '} - Zerops command line tool, pip and{' '} - git. + Zerops command line tool, `pip` and{' '} + `git`.

:::info @@ -244,7 +244,7 @@ When the build cache is used, Zerops doesn't run the `prepareCommands` commands ### 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. +_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. ```yml # REQUIRED. Select which files / folders to deploy after @@ -304,7 +304,7 @@ deployFiles: ./path/~/to/ #### .deployignore -Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a .gitignore file. +Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a `.gitignore` file. Example to ignore `src/file.txt` file in deploy: @@ -320,7 +320,7 @@ src / file.txt; ``` :::note -`.deployignore` file also works with zcli service deploy command. +`.deployignore` file also works with `zcli service deploy` command. ::: ### cache @@ -395,8 +395,8 @@ zerops:

The base runtime environment contains {data.alpineCurrentVersion}, the selected major version of Python,{' '} - Zerops command line tool, pip and{' '} - git. + Zerops command line tool, `pip` and{' '} + `git`.

:::info @@ -471,8 +471,8 @@ _OPTIONAL._ Customises the Python runtime environment by installing additional d

The base Python environment contains {data.alpineCurrentVersion}, the selected major version of Python,{' '} - Zerops command line tool, pip and{' '} - git. To install additional packages or tools add one or more + Zerops command line tool, `pip` and{' '} + `git`. To install additional packages or tools add one or more prepare commands:

@@ -525,8 +525,8 @@ You can configure your prepare commands to be run in a single shell instance or

The prepare runtime container contains {data.alpineCurrentVersion} the selected major version of Python,{' '} - Zerops command line tool, pip and{' '} - git. + Zerops command line tool, `pip` and{' '} + `git`.

The prepare runtime container does not contain your application code nor the built application. If you need to copy some folders or files from the build container to the runtime container (e.g. a configuration file) use the `addToRunPrepare` attribute in the [build section](#build-pipeline-configuration). diff --git a/apps/docs/content/python/how-to/build-process.mdx b/apps/docs/content/python/how-to/build-process.mdx index 0f889e79..cbfd8b1c 100644 --- a/apps/docs/content/python/how-to/build-process.mdx +++ b/apps/docs/content/python/how-to/build-process.mdx @@ -43,7 +43,7 @@ The default Python build environment contains: - [zCLI](/references/cli), Zerops command line tool - `pip` and `git` -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/python/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/python/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. :::info The application code is available in the `/var/www` folder in your build container before the prepare commands are triggered. This allows you to use any file from your application code in your prepare commands (e.g. a configuration file). diff --git a/apps/docs/content/python/how-to/create.mdx b/apps/docs/content/python/how-to/create.mdx index 40ab1d68..5ae824c4 100644 --- a/apps/docs/content/python/how-to/create.mdx +++ b/apps/docs/content/python/how-to/create.mdx @@ -268,7 +268,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -283,16 +283,16 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type python and version. + Specifies the service type `python` and version.
Set type:{' '} - + ` python@<version> - {' '} + `{' '} or{' '} - + ` python@latest - + `

Limitations: @@ -320,8 +320,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/python/how-to/customize-runtime.mdx b/apps/docs/content/python/how-to/customize-runtime.mdx index e1aafbc8..da49a7a2 100644 --- a/apps/docs/content/python/how-to/customize-runtime.mdx +++ b/apps/docs/content/python/how-to/customize-runtime.mdx @@ -18,12 +18,12 @@ The default Python runtime environment contains: - {data.alpineCurrentVersion} - selected version of Python selected when the runtime service was created. - - zCLI + `zCLI` , Zerops command line tool - `pip` and `git` -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more run.prepareCommands commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more `run.prepareCommands` commands to your `zerops.yml`. When the first deploy with a defined `prepareCommands` attribute is triggered, Zerops will @@ -41,7 +41,7 @@ The prepare runtime container is automatically deleted after the prepare runtime Some packages or tools can take a long time to install. Therefore, Zerops caches your custom runtime environment after the installation of your custom packages or tools is completed. When the second or following deploy is triggered, Zerops will use the custom runtime cache from the previous deploy if following conditions are met: -1. Content of the build.addToRunPrepare and run.prepareCommands attributes didn't change from the previous deploy +1. Content of the `build.addToRunPrepare` and `run.prepareCommands` attributes didn't change from the previous deploy 2. The custom runtime cache wasn't invalidated in the Zerops GUI. To invalidate the custom runtime cache go to `yyy` diff --git a/apps/docs/content/python/how-to/deploy-process.mdx b/apps/docs/content/python/how-to/deploy-process.mdx index 9d63069c..995abece 100644 --- a/apps/docs/content/python/how-to/deploy-process.mdx +++ b/apps/docs/content/python/how-to/deploy-process.mdx @@ -39,11 +39,11 @@ Zerops performs following actions for each new container: Services with multiple containers are deployed in parallel. :::info -If your application needs to be initialized in each runtime container, add [init commands](/python/how-to/build-pipeline#initcommands) to zerops.yml. +If your application needs to be initialized in each runtime container, add [init commands](/python/how-to/build-pipeline#initcommands) to `zerops.yml`. ::: :::caution -Do not use the initCommands for customising your runtime environment. See [how to customise the runtime environment](/python/how-to/deploy-process#customise-python-runtime-environment). +Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/python/how-to/deploy-process#customise-python-runtime-environment). ::: ## Further deploys @@ -70,9 +70,9 @@ Application in the runtime container with a pending readiness check won't receiv If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy. -The httpGet readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. +The `httpGet` readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. -The exec.command readiness check is successful when the command returns status code 0. The timeout is 5 seconds. +The `exec.command` readiness check is successful when the command returns status code 0. The timeout is 5 seconds. Read the [runtime log](/python/how-to/logs#runtime-log) to troubleshoot failed readiness checks. diff --git a/apps/docs/content/python/how-to/logs.mdx b/apps/docs/content/python/how-to/logs.mdx index f038ad37..ec789f2b 100644 --- a/apps/docs/content/python/how-to/logs.mdx +++ b/apps/docs/content/python/how-to/logs.mdx @@ -94,7 +94,7 @@ logger.Info('<7>Debug (7) severity > debug-level message.') :::info -logger.Info, logger.Warning, logger.Debug -, logger.Error and logger.Critical are just aliases to -the logger.Info method. They don't set the appropriate severity -number. Use the <N> prefix instead. ::: +`logger.Info`, `logger.Warning`, `logger.Debug` +, `logger.Error` and `logger.Critical` are just aliases to +the `logger.Info` method. They don't set the appropriate severity +number. Use the `<N>` prefix instead. ::: diff --git a/apps/docs/content/python/how-to/trigger-pipeline.mdx b/apps/docs/content/python/how-to/trigger-pipeline.mdx index e02de27e..61bccc8b 100644 --- a/apps/docs/content/python/how-to/trigger-pipeline.mdx +++ b/apps/docs/content/python/how-to/trigger-pipeline.mdx @@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t

:::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ### Skip the automatic pipeline once @@ -60,7 +60,7 @@ To start a new build & deploy pipeline manually, use the Zerops CLI. Follow these steps: -1. Add zerops.yml to your repository. +1. Add `zerops.yml` to your repository. 2. [Install & setup zCLI](/references/cli) the Zerops command line tool. 3. Run `zcli push` command. @@ -96,7 +96,7 @@ Flags: zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from. :::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ## Manual deploy using Zerops CLI @@ -138,5 +138,5 @@ Flags: `zerops.yml` must be placed in the working directory. :::info -You can change the deploy pipeline when you need to. Just simply modify the zerops.yml in your working directory. +You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory. ::: diff --git a/apps/docs/content/python/how-to/upgrade.mdx b/apps/docs/content/python/how-to/upgrade.mdx index 71be5d0d..df668efc 100644 --- a/apps/docs/content/python/how-to/upgrade.mdx +++ b/apps/docs/content/python/how-to/upgrade.mdx @@ -2,6 +2,6 @@ title: How to upgrade the Python version --- -You can upgrade or downgrade your Python service to a different major Python version by setting the run.base parameter in your `zerops.yml`. When you [trigger a new pipeline](/python/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Python version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Python version for your runtime. +You can upgrade or downgrade your Python service to a different major Python version by setting the `run.base` parameter in your `zerops.yml`. When you [trigger a new pipeline](/python/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Python version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Python version for your runtime. -If you want to build your application with a different major Python version, change the build.base parameter in your `zerops.yml`. The `build.base` is the required attribute. +If you want to build your application with a different major Python version, change the `build.base` parameter in your `zerops.yml`. The `build.base` is the required attribute. diff --git a/apps/docs/content/python/tutorial/quickstart.mdx b/apps/docs/content/python/tutorial/quickstart.mdx index 9713ee82..1bf7642b 100644 --- a/apps/docs/content/python/tutorial/quickstart.mdx +++ b/apps/docs/content/python/tutorial/quickstart.mdx @@ -29,7 +29,7 @@ services: **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://helloworld-24-8080.prg1.zerops.app`. -2. Click or the subdomain URL to open it in a browser and you should see +2. Click or the `subdomain` URL to open it in a browser and you should see ``` Hello, World! diff --git a/apps/docs/content/python/tutorial/runtime-sql.mdx b/apps/docs/content/python/tutorial/runtime-sql.mdx index 469edf63..ee411ace 100644 --- a/apps/docs/content/python/tutorial/runtime-sql.mdx +++ b/apps/docs/content/python/tutorial/runtime-sql.mdx @@ -32,7 +32,7 @@ In the detail of each step, you can find a link with more information about the
3. In the left menu, click on Import services, copy & paste the - contents of the import-services.yml config file from the recipe + contents of the `import-services.yml` config file from the recipe repository of your choice. Then click on Import service.

@@ -45,7 +45,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -75,7 +75,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 + 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

`Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1`

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. @@ -86,14 +86,14 @@ For now, check out other features, such as access it.

Learn more about how to{' '} - use psql + use `psql` {' '} command-line tool instead or how to{' '} import and export data{' '} diff --git a/apps/docs/content/python/tutorial/step-by-step.mdx b/apps/docs/content/python/tutorial/step-by-step.mdx index 0b6828b8..8dd12ddf 100644 --- a/apps/docs/content/python/tutorial/step-by-step.mdx +++ b/apps/docs/content/python/tutorial/step-by-step.mdx @@ -48,7 +48,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -78,7 +78,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with Hello World! printed. + 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with `Hello World!` printed.

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. diff --git a/apps/docs/content/rabbitmq/how-to/create.mdx b/apps/docs/content/rabbitmq/how-to/create.mdx index c7d34784..9f965312 100644 --- a/apps/docs/content/rabbitmq/how-to/create.mdx +++ b/apps/docs/content/rabbitmq/how-to/create.mdx @@ -186,7 +186,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new service will be set to the - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -201,12 +201,12 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type rabbitmq and version. + Specifies the service type `rabbitmq` and version.
Set type:{' '} - + ` rabbitmq@XXX - + ` Currently only RabbitMQ XXX is available. diff --git a/apps/docs/content/references/cli/commands.mdx b/apps/docs/content/references/cli/commands.mdx index a2cdd485..f65b681d 100644 --- a/apps/docs/content/references/cli/commands.mdx +++ b/apps/docs/content/references/cli/commands.mdx @@ -207,7 +207,7 @@ _Flags_: #### .deployignore -Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a .gitignore file. +Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a `.gitignore` file. Example to ignore `src/file.txt` file in deploy: diff --git a/apps/docs/content/references/vpn.mdx b/apps/docs/content/references/vpn.mdx index 4ab71343..195eacfc 100644 --- a/apps/docs/content/references/vpn.mdx +++ b/apps/docs/content/references/vpn.mdx @@ -19,7 +19,7 @@ Flags: command is to be executed. ``` -You must enclose the project name in quotes if it contains a space. The project name is visible in Zerops GUI. If you have more projects with a duplicate name, use the project ID instead. You'll find the project ID in the URL of the project dashboard page in Zerops GUI.
E.g. https://app.zerops.io/project/Evs8Je4NTvKeIkUqoUXp2w/service-stacks. +You must enclose the project name in quotes if it contains a space. The project name is visible in Zerops GUI. If you have more projects with a duplicate name, use the project ID instead. You'll find the project ID in the URL of the project dashboard page in Zerops GUI.
E.g. `https://app.zerops.io/project/Evs8Je4NTvKeIkUqoUXp2w/service-stacks`. :::info When you run the `zcli vpn up` command for the first time, you will be asked if you want to install the Zerops VPN daemon to your computer. Confirm the installation by entering `y`. Then zCLI prompts for your root/administrator password to your computer. diff --git a/apps/docs/content/references/vpn/faq.mdx b/apps/docs/content/references/vpn/faq.mdx index 38dd703e..caeadab6 100644 --- a/apps/docs/content/references/vpn/faq.mdx +++ b/apps/docs/content/references/vpn/faq.mdx @@ -7,21 +7,21 @@ import { FAQ, FAQItem } from '/src/components/Faq';

- The reason can be that systemd is not running in WSL2 by + The reason can be that `systemd` is not running in WSL2 by default. To fix this:

  1. - Run sudo -e /etc/wsl.conf + Run `sudo -e /etc/wsl.conf`
  2. - Add system=true to [boot] section + Add `system=true` to `[boot]` section
  3. Comment out the first line{' '} - LABEL=cloudimg-rootfs / ext4 defaults 0 1 + `LABEL=cloudimg-rootfs / ext4 defaults 0 1`
  4. - In cmd.exe/PowerShell run wsl --shutdown to + In `cmd.exe/PowerShell` run ` wsl --shutdown` to restart WSL2.
diff --git a/apps/docs/content/references/zeropsyml.mdx b/apps/docs/content/references/zeropsyml.mdx index 34afa086..b0e05fe9 100644 --- a/apps/docs/content/references/zeropsyml.mdx +++ b/apps/docs/content/references/zeropsyml.mdx @@ -88,7 +88,7 @@ Choose the technology to read more about what tools are pre-installed in differe - [Java](/java/how-to/build-pipeline#base) - [nginx static](/nginx/how-to/build-pipeline#base) -To customise your build environment use the prepareCommands attribute. +To customise your build environment use the `prepareCommands` attribute. ### os @@ -188,7 +188,7 @@ If the command ends successfully, it returns the exit code 0 and Zerops triggers ### 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. +_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. ```yml # REQUIRED. Select which files / folders to deploy after @@ -251,7 +251,7 @@ deployFiles: ./path/~/to/ #### .deployignore -Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a .gitignore file. +Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a `.gitignore` file. Example to ignore `node_modules` folder in deploy: @@ -267,7 +267,7 @@ node_modules; ``` :::note -`.deployignore` file also works with zcli service deploy command. +`.deployignore` file also works with `zcli service deploy` command. ::: ### cache @@ -330,7 +330,7 @@ _OPTIONAL._ Sets the base technology for the runtime environment. If you don't s See the full list of [available options](/references/zeropsyml/base-list). :::info -You can change the base environment when you need to. Just simply modify the zerops.yml in your repository. +You can change the base environment when you need to. Just simply modify the `zerops.yml` in your repository. ::: If you need to install more technologies to the runtime environment, set multiple values as a yaml array. For example: diff --git a/apps/docs/content/rust/how-to/access.mdx b/apps/docs/content/rust/how-to/access.mdx index e4d0b5cf..3e7bffe9 100644 --- a/apps/docs/content/rust/how-to/access.mdx +++ b/apps/docs/content/rust/how-to/access.mdx @@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers To connect to your application with `app` hostname running on [internal port](/rust/how-to/build-pipeline#ports) `8080`, simply use `http://app:8080` :::info -Do not use https:// when communicating with Rust from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Rust from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects. ::: ### Use Rust environment variables @@ -41,12 +41,12 @@ You can securely connect to your Rust application from your local workspace via Once the VPN session is established, you have the secured connection to the project's private network in Zerops. You can access all project services locally by using their hostname. The only difference is that no [environment variables](/rust/how-to/env-variables) are available when connected through VPN. To connect to your Rust application in Zerops set the hostname and [internal port](/rust/how-to/build-pipeline#ports) e.g. http://app:8080 :::info -Do not use https:// when communicating with Rust over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. +Do not use `https://` when communicating with Rust over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects. ::: ### Connect via SSH -Use the ssh command to connect to your service via SSH. +Use the `ssh` command to connect to your service via SSH. ### Stop VPN connection diff --git a/apps/docs/content/rust/how-to/build-pipeline.mdx b/apps/docs/content/rust/how-to/build-pipeline.mdx index 1cd8df55..1948c72d 100644 --- a/apps/docs/content/rust/how-to/build-pipeline.mdx +++ b/apps/docs/content/rust/how-to/build-pipeline.mdx @@ -114,7 +114,7 @@ zerops:

The base build environment contains {data.alpineCurrentVersion}, the selected major version of Rust, Zerops command line tool,{' '} - npm , yarn, git and npx{' '} + `npm` , `yarn`, `git` and `npx`{' '} tools.

@@ -278,7 +278,7 @@ If the command ends successfully, it returns the exit code 0 and Zerops triggers ### 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. +_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. ```yml # REQUIRED. Select which files / folders to deploy after @@ -338,7 +338,7 @@ deployFiles: ./path/~/to/ #### .deployignore -Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a .gitignore file. +Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a `.gitignore` file. Example to ignore `src/file.txt` file in deploy: @@ -354,7 +354,7 @@ src / file.txt; ``` :::note -`.deployignore` file also works with zcli service deploy command. +`.deployignore` file also works with `zcli service deploy` command. ::: ### cache @@ -504,8 +504,8 @@ _OPTIONAL._ Customises the Rust runtime environment by installing additional dep

The base Rust environment contains {data.alpineCurrentVersion}, the selected major version of Rust, Zerops command line tool{' '} - and npm , yarn, git and{' '} - npx tools. To install additional packages or tools add one or + and `npm` , `yarn`, `git` and{' '} + `npx` tools. To install additional packages or tools add one or more prepare commands:

@@ -566,8 +566,8 @@ You can configure your prepare commands to be run in a single shell instance or

The prepare runtime container contains {data.alpineCurrentVersion}, the selected major version of Rust,{' '} - Zerops command line tool and npm ,{' '} - yarn, git and npx tools. + Zerops command line tool and `npm` ,{' '} + `yarn`, `git` and `npx` tools.

The prepare runtime container does not contain your application code nor the built application. If you need to copy some folders or files from the build container to the runtime container (e.g. a configuration file) use the `addToRunPrepare` attribute in the [build section](#build-pipeline-configuration). diff --git a/apps/docs/content/rust/how-to/build-process.mdx b/apps/docs/content/rust/how-to/build-process.mdx index dabbafd9..7d3ded55 100644 --- a/apps/docs/content/rust/how-to/build-process.mdx +++ b/apps/docs/content/rust/how-to/build-process.mdx @@ -44,7 +44,7 @@ The default Rust build environment contains: - [zCLI](/references/cli), Zerops command line tool - `npm`, `yarn`, `git` and `npx` tools -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/rust/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/rust/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`. :::info The application code is available in the `/var/www` folder in your build container before the prepare commands are triggered. This allows you to use any file from your application code in your prepare commands (e.g. a configuration file). diff --git a/apps/docs/content/rust/how-to/create.mdx b/apps/docs/content/rust/how-to/create.mdx index df40006c..a508ca97 100644 --- a/apps/docs/content/rust/how-to/create.mdx +++ b/apps/docs/content/rust/how-to/create.mdx @@ -268,7 +268,7 @@ At least one service in `services:` section is required. You can create a projec

The hostname of the new database will be set to the{' '} - hostname value.
+ `hostname` value.

Limitations:
- duplicate services with the same name in the same project are @@ -283,16 +283,16 @@ At least one service in `services:` section is required. You can create a projec type - Specifies the service type rust and version. + Specifies the service type `rust` and version.
Set type:{' '} - + ` rust@<version> - {' '} + `{' '} or{' '} - + ` rust@latest - + `

Limitations: @@ -319,8 +319,8 @@ At least one service in `services:` section is required. You can create a projec - cpuMode - Optional. Accepts SHARED, DEDICATED{' '} - values. Default is SHARED + Optional. Accepts `SHARED`, `DEDICATED`{' '} + values. Default is `SHARED` diff --git a/apps/docs/content/rust/how-to/customize-runtime.mdx b/apps/docs/content/rust/how-to/customize-runtime.mdx index 42b8c3f2..5c6964be 100644 --- a/apps/docs/content/rust/how-to/customize-runtime.mdx +++ b/apps/docs/content/rust/how-to/customize-runtime.mdx @@ -18,12 +18,12 @@ The default Rust runtime environment contains: - {data.alpineCurrentVersion} - selected version of Rust selected when the runtime service was created. - - zCLI + `zCLI` , Zerops command line tool - `npm`, `yarn`, `git` and `npx` tools -If you prefer the Ubuntu OS instead of Alpine, set the build.os attribute to `ubuntu`. To install additional packages or tools add one or more run.prepareCommands commands to your `zerops.yml`. +If you prefer the Ubuntu OS instead of Alpine, set the `build.os` attribute to `ubuntu`. To install additional packages or tools add one or more `run.prepareCommands` commands to your `zerops.yml`. When the first deploy with a defined `prepareCommands` attribute is triggered, Zerops will @@ -41,7 +41,7 @@ The prepare runtime container is automatically deleted after the prepare runtime Some packages or tools can take a long time to install. Therefore, Zerops caches your custom runtime environment after the installation of your custom packages or tools is completed. When the second or following deploy is triggered, Zerops will use the custom runtime cache from the previous deploy if following conditions are met: -1. Content of the build.addToRunPrepare and run.prepareCommands attributes didn't change from the previous deploy +1. Content of the `build.addToRunPrepare` and `run.prepareCommands` attributes didn't change from the previous deploy 2. The custom runtime cache wasn't invalidated in the Zerops GUI. To invalidate the custom runtime cache go to `yyy` diff --git a/apps/docs/content/rust/how-to/deploy-process.mdx b/apps/docs/content/rust/how-to/deploy-process.mdx index f82e0eaa..b0a3b9e4 100644 --- a/apps/docs/content/rust/how-to/deploy-process.mdx +++ b/apps/docs/content/rust/how-to/deploy-process.mdx @@ -39,11 +39,11 @@ Zerops performs following actions for each new container: Services with multiple containers are deployed in parallel. :::info -If your application needs to be initialized in each runtime container, add [init commands](/rust/how-to/build-pipeline#initcommands) to zerops.yml. +If your application needs to be initialized in each runtime container, add [init commands](/rust/how-to/build-pipeline#initcommands) to `zerops.yml`. ::: :::caution -Do not use the initCommands for customising your runtime environment. See [how to customise the runtime environment](/rust/how-to/deploy-process#customise-rust-runtime-environment). +Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/rust/how-to/deploy-process#customise-rust-runtime-environment). ::: ## Further deploys @@ -70,9 +70,9 @@ Application in the runtime container with a pending readiness check won't receiv If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy. -The httpGet readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. +The `httpGet` readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect. -The exec.command readiness check is successful when the command returns status code 0. The timeout is 5 seconds. +The `exec.command` readiness check is successful when the command returns status code 0. The timeout is 5 seconds. Read the [runtime log](/rust/how-to/logs#runtime-log) to troubleshoot failed readiness checks. diff --git a/apps/docs/content/rust/how-to/logs.mdx b/apps/docs/content/rust/how-to/logs.mdx index 8f6b9ff6..5583d3f2 100644 --- a/apps/docs/content/rust/how-to/logs.mdx +++ b/apps/docs/content/rust/how-to/logs.mdx @@ -92,9 +92,9 @@ console.log('<7>Debug (7) severity > debug-level message.'); :::info -console.info, console.warn, console.debug -, and console.error are just aliases to the +`console.info`, `console.warn`, `console.debug` +, and `console.error` are just aliases to the ` console.log - method. They don't set the appropriate severity number. Use the +` method. They don't set the appropriate severity number. Use the ` <N> - prefix instead. ::: +` prefix instead. ::: diff --git a/apps/docs/content/rust/how-to/trigger-pipeline.mdx b/apps/docs/content/rust/how-to/trigger-pipeline.mdx index 1319ff3e..673a3d63 100644 --- a/apps/docs/content/rust/how-to/trigger-pipeline.mdx +++ b/apps/docs/content/rust/how-to/trigger-pipeline.mdx @@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t

:::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ### Skip the automatic pipeline once @@ -60,7 +60,7 @@ To start a new build & deploy pipeline manually, use the Zerops CLI. Follow these steps: -1. Add zerops.yml to your repository. +1. Add `zerops.yml` to your repository. 2. [Install & setup zCLI](/references/cli) the Zerops command line tool. 3. Run `zcli push` command. @@ -96,7 +96,7 @@ Flags: zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from. :::info -You can change the build and deploy pipeline when you need to. Just simply modify the zerops.yml in your repository. +You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository. ::: ## Manual deploy using Zerops CLI @@ -138,5 +138,5 @@ Flags: `zerops.yml` must be placed in the working directory. :::info -You can change the deploy pipeline when you need to. Just simply modify the zerops.yml in your working directory. +You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory. ::: diff --git a/apps/docs/content/rust/how-to/upgrade.mdx b/apps/docs/content/rust/how-to/upgrade.mdx index 2925b106..6a09ab5b 100644 --- a/apps/docs/content/rust/how-to/upgrade.mdx +++ b/apps/docs/content/rust/how-to/upgrade.mdx @@ -2,6 +2,6 @@ title: How to upgrade the Rust version --- -You can upgrade or downgrade your Rust service to a different major Rust version by setting the run.base parameter in your `zerops.yml`. When you [trigger a new pipeline](/rust/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Rust version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Rust version for your runtime. +You can upgrade or downgrade your Rust service to a different major Rust version by setting the `run.base` parameter in your `zerops.yml`. When you [trigger a new pipeline](/rust/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required Rust version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current Rust version for your runtime. -If you want to build your application with a different major Rust version, change the build.base parameter in your `zerops.yml`. The `build.base` is the required attribute. +If you want to build your application with a different major Rust version, change the `build.base` parameter in your `zerops.yml`. The `build.base` is the required attribute. diff --git a/apps/docs/content/rust/tutorial/quickstart.mdx b/apps/docs/content/rust/tutorial/quickstart.mdx index 81bd93a2..fd6b2d02 100644 --- a/apps/docs/content/rust/tutorial/quickstart.mdx +++ b/apps/docs/content/rust/tutorial/quickstart.mdx @@ -29,7 +29,7 @@ services: **That's it, your application is now up and running! :star: Let's check it works:** 1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://helloworld-24-8080.prg1.zerops.app`. -2. Click or the subdomain URL to open it in a browser and you should see +2. Click or the `subdomain` URL to open it in a browser and you should see ``` Hello, World! diff --git a/apps/docs/content/rust/tutorial/runtime-sql.mdx b/apps/docs/content/rust/tutorial/runtime-sql.mdx index f23878fa..8f6bfa54 100644 --- a/apps/docs/content/rust/tutorial/runtime-sql.mdx +++ b/apps/docs/content/rust/tutorial/runtime-sql.mdx @@ -32,7 +32,7 @@ In the detail of each step, you can find a link with more information about the
3. In the left menu, click on Import services, copy & paste the - contents of the import-services.yml config file from the recipe + contents of the `import-services.yml` config file from the recipe repository of your choice. Then click on Import service.

@@ -45,7 +45,7 @@ In the detail of each step, you can find a link with more information about the to an existing project.

- The yaml file includes a buildFromGit directive, which ensures + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -72,7 +72,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1 + 6. Once the pipeline has finished, click on the activated subdomain URL. You should see a simple page with

`Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1`

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon. @@ -83,14 +83,14 @@ For now, check out other features, such as

- 7. One of the services is adminer, a database management tool. + 7. One of the services is `adminer`, a database management tool. See how to{' '} access it.

Learn more about how to{' '} - use psql + use `psql` {' '} command-line tool instead or how to{' '} import and export data{' '} diff --git a/apps/docs/content/rust/tutorial/step-by-step.mdx b/apps/docs/content/rust/tutorial/step-by-step.mdx index 7c0ed703..25512721 100644 --- a/apps/docs/content/rust/tutorial/step-by-step.mdx +++ b/apps/docs/content/rust/tutorial/step-by-step.mdx @@ -61,7 +61,7 @@ In the detail of each step, you can find a link with more information about the {" "}

- The yaml file includes a buildFromGit directive, which ensures a + The yaml file includes a `buildFromGit` directive, which ensures a one-time build from Git repository source. See how to connect a{' '} Github or{' '} Gitlab repository to be able to @@ -92,7 +92,7 @@ Learn more about how to access build log

- 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with Hello World! printed. + 6. Once the pipeline has finished, click on the activated subdomain URL:

You should see a simple page with `Hello World!` printed.

Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon.