Skip to content

Developer first page #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 61 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
61 commits
Select commit Hold shift + click to select a range
405b0e9
init developer first page
nermalcat69 Feb 6, 2025
602a6ad
Update developer-first.mdx
nermalcat69 Feb 9, 2025
1b6f0c7
cloudflare (#189)
vankovap Feb 11, 2025
72aac59
env variables update (#190)
vankovap Feb 11, 2025
c948ca1
dns update (#191)
vankovap Feb 12, 2025
422def0
Cloudflare (#192)
vankovap Feb 12, 2025
5c16dd7
fix link (#193)
vankovap Feb 12, 2025
b538c7b
fix(docs): Run development on Windows platform
mlc-mlapis Feb 15, 2025
1805704
Merge pull request #194 from zeropsio/ML-Run_Docs_On_Windows_Platform
mlc-mlapis Feb 15, 2025
5bc9b45
qdrant (#195)
vankovap Feb 16, 2025
478ca35
qdrant (#196)
vankovap Feb 16, 2025
1a03ffc
api basic (#198)
vankovap Feb 18, 2025
96a800c
minVCpu -> minCpu (#199)
vankovap Feb 21, 2025
97f554d
resources update (#200)
vankovap Feb 21, 2025
a7b9ae0
egress pricing update (#201)
vankovap Feb 22, 2025
15e041f
pdf export update (#202)
vankovap Feb 23, 2025
cf73c82
pdf export update (#203)
vankovap Feb 25, 2025
ad12213
postgres plugins (#204)
vankovap Feb 28, 2025
5be2633
zerops suffix (#205)
vankovap Mar 1, 2025
5757c50
code block + typesense persistence (#206)
vankovap Mar 3, 2025
58c34dd
code block + postgresql links (#207)
vankovap Mar 4, 2025
4067ab5
core package (#209)
vankovap Mar 6, 2025
ca30389
categories (#210)
vankovap Mar 6, 2025
0db2edc
delete empty pages (#211)
vankovap Mar 7, 2025
d9e59a0
docker envs (#212)
vankovap Mar 9, 2025
25c6db5
shared storage (#213)
vankovap Mar 13, 2025
c03670f
apache fix (#214)
vankovap Mar 13, 2025
25ccc12
shared storage (#216)
vankovap Mar 15, 2025
bcfdbf1
Improve Faq (#179)
nermalcat69 Mar 19, 2025
ceae41b
topup (#218)
vankovap Mar 20, 2025
1513744
topup (#219)
vankovap Mar 21, 2025
4209e6c
about (#220)
vankovap Mar 21, 2025
ebcf85c
About (#221)
vankovap Mar 21, 2025
cb05f43
wildcards (#222)
vankovap Mar 24, 2025
561ee53
diagrams (#223)
vankovap Mar 24, 2025
6c5946c
extends (#224)
vankovap Mar 27, 2025
171d88f
Zcli (#225)
vankovap Apr 1, 2025
db0df9b
postgres superuser note (#227)
vankovap Apr 2, 2025
a8dcd1e
LLM Friendly Docs (#226)
nermalcat69 Apr 2, 2025
008bc43
chore(deps-dev): bump next from 14.2.15 to 14.2.25 (#228)
dependabot[bot] Apr 3, 2025
2763a95
cdn (#230)
vankovap Apr 4, 2025
6c34519
zcli yaml (#231)
vankovap Apr 7, 2025
a336dc2
cdn purge (#233)
vankovap Apr 8, 2025
e0f2537
zcli yaml (#232)
vankovap Apr 9, 2025
51f7434
superuser for psql plugins (#234)
vankovap Apr 9, 2025
cd75194
valkey (#235)
vankovap Apr 10, 2025
4062e72
fix discord link (#236)
vankovap Apr 10, 2025
4e2595b
keydb overview (#237)
vankovap Apr 11, 2025
8051f46
direct IP access (#238)
vankovap Apr 11, 2025
f17533b
import (#244)
vankovap Apr 13, 2025
8c407ab
import (#245)
vankovap Apr 14, 2025
bdd92e8
nats (#239)
vankovap Apr 14, 2025
db1d7db
remove faq pages (#246)
nermalcat69 Apr 15, 2025
2cfad61
Improve LLM Texts (#248)
nermalcat69 Apr 15, 2025
7adbd99
Update zerops-llm-script.ts
fxck Apr 15, 2025
6dcf52a
nats envs (#250)
vankovap Apr 16, 2025
3fcf8b1
Refine llm script (#249)
nermalcat69 Apr 18, 2025
a2f69f5
init developer first page
nermalcat69 Feb 6, 2025
6499dd2
Update developer-first.mdx
nermalcat69 Feb 9, 2025
a311826
Merge branch 'dev-first' of https://github.com/zeropsio/docs into dev…
nermalcat69 Apr 18, 2025
36f02ab
iterate
nermalcat69 Apr 19, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions apps/docs/.content.eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
module.exports = {
root: true,
extends: ['docs/content'],
rules: {
'quotes': ['error', 'single'],
'semi': ['error', 'always'],
'max-len': ['error', { code: 80, ignoreComments: true }]
}
};
10 changes: 0 additions & 10 deletions apps/docs/content/bun/faq.mdx

This file was deleted.

4 changes: 2 additions & 2 deletions apps/docs/content/bun/how-to/access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ Use the <a href="/references/ssh">`ssh` command</a> to connect to your service v

## Public access through zerops.io subdomain

By default, your Bun service is not publicly accessible. To test your application, enable the [public access through zerops.io subdomain](/features/access#public-access-through-zeropsapp-subdomain).
By default, your Bun service is not publicly accessible. To test your application, enable the [public access through zerops.io subdomain](/features/access#public-access-through-zerops-subdomain).

## Public access through your domain

By default, your Bun service is not publicly accessible. When your application is ready for production or if you want to test it on the production domain, [configure the public access through your domain](/features/access#public-access-through-your-domain).

## Public access from another Zerops project

All services of the same project share a dedicated private network. To connect to a service within the same project, just use the service hostname and its [internal port](bun/how-to/build-pipeline#ports). Different projects are not connected inside Zerops. To connect to a runtime service from another Zerops project, you need to use public access either [through zerops.io subdomain](/features/access#public-access-through-zeropsapp-subdomain) or [through your domain](/features/access#public-access-through-your-domain).
All services of the same project share a dedicated private network. To connect to a service within the same project, just use the service hostname and its [internal port](bun/how-to/build-pipeline#ports). Different projects are not connected inside Zerops. To connect to a runtime service from another Zerops project, you need to use public access either [through zerops.io subdomain](/features/access#public-access-through-zerops-subdomain) or [through your domain](/features/access#public-access-through-your-domain).
82 changes: 41 additions & 41 deletions apps/docs/content/bun/how-to/build-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import UnorderedCodeList from 'docs/src/components/UnorderedCodeList';

Zerops provides a customizable build and runtime environment for your Bun application.

## Add zerops.yml to your repository
## Add zerops.yaml to your repository

Start by adding `zerops.yml` file to the **root of your repository** and modify it to fit your application:
Start by adding `zerops.yaml` file to the **root of your repository** and modify it to fit your application:

```yml
```yaml
zerops:
# define hostname of your service
- setup: app
Expand Down Expand Up @@ -78,9 +78,9 @@ The top-level element is always `zerops`.
### Setup

The first element `setup` contains the **hostname** of your service. A runtime service with the same hostname must exist in Zerops.
Zerops supports the definition of multiple runtime services in a single `zerops.yml`. This is useful when you use a monorepo. Just add multiple setup elements in your `zerops.yml`:
Zerops supports the definition of multiple runtime services in a single `zerops.yaml`. This is useful when you use a monorepo. Just add multiple setup elements in your `zerops.yaml`:

```yml
```yaml
zerops:
# definition for app service
- setup: app
Expand All @@ -105,7 +105,7 @@ Following options are available for Bun builds:

<UnorderedCodeList data={data.bun.base} />

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand All @@ -124,12 +124,12 @@ zerops:
</p>

:::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.yaml` in your repository.
:::

If you need to install more technologies to the build environment, set multiple values as a yaml array. For example:

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand All @@ -143,7 +143,7 @@ zerops:
...
```

See the full list of supported [build base environments](/zerops-yml/base-list#runtime-services).
See the full list of supported [build base environments](/zerops-yaml/base-list#runtime-services).

To customise your build environment use the [prepareCommands](bun/how-to/build-pipeline#preparecommands) attribute.

Expand Down Expand Up @@ -188,7 +188,7 @@ The base build environment contains:

To install additional packages or tools add one or more prepare commands:

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand Down Expand Up @@ -229,7 +229,7 @@ You can configure your prepare commands to be run in a single shell instance or

_REQUIRED._ Defines build commands.

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand Down Expand Up @@ -257,7 +257,7 @@ Before the build commands are triggered the build container contains:

Use following syntax to run all commands in the same environment context. For example, if one command changes the current directory, the next command continues in that directory. When one command creates an environment variable, the next command can access it.

```yml
```yaml
buildCommands:
- |
bun i
Expand All @@ -268,7 +268,7 @@ buildCommands:

When the following syntax is used, each command is triggered in a separate environment context. For example, each shell instance starts in the home directory again. When one command creates an environment variable, it won't be available for the next command.

```yml
```yaml
buildCommands:
- bun i
- bun run build
Expand All @@ -278,7 +278,7 @@ buildCommands:

If any command fails, it returns an exit code other than 0 and the build is canceled. Read the [build log](bun/how-to/logs#build-log) to troubleshoot the error. If the error log doesn't contain any specific error message, try to run your build with the --verbose option.

```yml
```yaml
buildCommands:
- bun i --verbose
- bun run build
Expand All @@ -290,7 +290,7 @@ If the command ends successfully, it returns the exit code 0 and Zerops triggers

_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use <a href="#deployignore">`.deployignore`</a> file.

```yml
```yaml
# REQUIRED. Select which files / folders to deploy after
# the build has successfully finished
deployFiles:
Expand All @@ -301,29 +301,29 @@ deployFiles:

Determines files or folders produced by your build, which should be deployed to your runtime service containers.

The path starts from the **root directory** of your project (the location of `zerops.yml`). You must enclose the name in quotes if the folder or the file name contains a space.
The path starts from the **root directory** of your project (the location of `zerops.yaml`). You must enclose the name in quotes if the folder or the file name contains a space.

The files/folders will be placed into `/var/www` folder in runtime, e.g. `./src/assets/fonts` would result in `/var/www/src/assets/fonts`.

#### Examples

Deploys a folder, and a file from the project root directory:

```yml
```yaml
deployFiles:
- dist
- package.json
```

Deploys the whole content of the build container:

```yml
```yaml
deployFiles: .
```

Deploys a folder, and a file in a defined path:

```yml
```yaml
deployFiles:
- ./path/to/file.txt
- ./path/to/dir/
Expand All @@ -335,19 +335,19 @@ Zerops supports the `~` character as a wildcard for one or more folders in the p

Deploys all `file.txt` files that are located in any path that begins with `/path/` and ends with `/to/`

```yml
```yaml
deployFiles: ./path/~/to/file.txt
```

Deploys all folders that are located in any path that begins with `/path/to/`

```yml
```yaml
deployFiles: ./path/to/~/
```

Deploys all folders that are located in any path that begins with `/path/` and ends with `/to/`

```yml
```yaml
deployFiles: ./path/~/to/
```

Expand All @@ -366,7 +366,7 @@ For consistency, it's recommended to configure both your `.gitignore` and `.depl

Examples:

```yml title="zerops.yml"
```yaml title="zerops.yaml"
zerops:
- setup: app
build:
Expand All @@ -393,7 +393,7 @@ This example above ignores `file.txt` in ANY directory named `src`, such as:

_OPTIONAL._ Defines which files or folders will be cached for the next build.

```yml
```yaml
# OPTIONAL. Which files / folders you want to cache for the next build.
# Next builds will be faster when the cache is used.
cache: file.txt
Expand All @@ -411,7 +411,7 @@ _OPTIONAL._ Defines the environment variables for the build environment.

Enter one or more env variables in following format:

```yml
```yaml
zerops:
# define hostname of your service
- setup: app
Expand Down Expand Up @@ -442,7 +442,7 @@ Following options are available for Bun runtimes:

<UnorderedCodeList data={data.bun.base} />

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand All @@ -465,12 +465,12 @@ zerops:
</p>

:::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.yaml` in your repository.
:::

If you need to install more technologies to the runtime environment, set multiple values as a yaml array. For example:

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand All @@ -490,7 +490,7 @@ zerops:
...
```

See the full list of supported [run base environments](/zerops-yml/base-list).
See the full list of supported [run base environments](/zerops-yaml/base-list).

To customise your build environment use the `prepareCommands` attribute.

Expand Down Expand Up @@ -540,7 +540,7 @@ _OPTIONAL._ Customises the Bun runtime environment by installing additional depe
additional packages or tools add one or more prepare commands:
</p>

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand Down Expand Up @@ -594,14 +594,14 @@ You can configure your prepare commands to be run in a single shell instance or

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).

```yml
```yaml
zerops:
# hostname of your service
- setup: app
# ==== how to build your application ====
build:
...
addToRunPrepare: ./runtime-config.yml
addToRunPrepare: ./runtime-config.yaml

# ==== how to run your application ====
run:
Expand All @@ -613,13 +613,13 @@ zerops:
...
```

In the example above Zerops will copy the `runtime-config.yml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.
In the example above Zerops will copy the `runtime-config.yaml` file from your build container **after the build has finished** into the new **prepare runtime** container. The copied files and folders will be available in the `xxx` folder in the new prepare runtime container before the prepare commands are triggered.

### initCommands

_OPTIONAL._ Defines one or more commands to be run each time a new runtime container is started or a container is restarted.

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand Down Expand Up @@ -659,7 +659,7 @@ _OPTIONAL._ Defines the environment variables for the runtime environment.

Enter one or more env variables in following format:

```yml
```yaml
zerops:
# define hostname of your service
- setup: app
Expand All @@ -680,7 +680,7 @@ Read more about [environment variables](bun/how-to/env-variables) in Zerops.

_REQUIRED._ Defines the start command for your Bun application.

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand Down Expand Up @@ -716,7 +716,7 @@ Following attributes are available:

**Example:**

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand Down Expand Up @@ -749,7 +749,7 @@ Following attributes are available:

**Example:**

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand Down Expand Up @@ -778,7 +778,7 @@ _OPTIONAL._ Defines cron jobs.

Setup cron jobs in the following format:

```yml
```yaml
zerops:
# define hostname of your service
- setup: app
Expand Down Expand Up @@ -817,7 +817,7 @@ Following attributes are available:

**Example:**

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand Down Expand Up @@ -850,7 +850,7 @@ Following attributes are available:

**Example:**

```yml
```yaml
zerops:
# hostname of your service
- setup: app
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/content/bun/how-to/build-process.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ The build cancellation is available before the build pipeline is finished. When
The default Bun build environment contains:

- <span>{data.alpine.default}</span>
- selected version of Bun defined in `zerops.yml` [build.base](bun/how-to/build-pipeline#base) parameter
- selected version of Bun defined in `zerops.yaml` [build.base](bun/how-to/build-pipeline#base) parameter
- [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](/bun/how-to/build-pipeline#os) attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](bun/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`.
If you prefer the Ubuntu OS instead of Alpine, set the [build.os](/bun/how-to/build-pipeline#os) attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](bun/how-to/build-pipeline#preparecommands) commands to your `zerops.yaml`.

:::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).
Expand Down Expand Up @@ -104,7 +104,7 @@ This will force Zerops to run the next build clean, including all prepare comman

If any [build command](bun/how-to/build-pipeline#buildcommands) fails, it returns an exit code other than 0 and the build is canceled. Read the [build log](bun/how-to/logs#build-log) to troubleshoot the error. If the error log doesn't contain any specific error message, try to run your build with the `--verbose` option.

```yml
```yaml
buildCommands:
- npm i --verbose
- npm run build
Expand Down
Loading