Squidex

https://github.com/squidex/squidex-docs2
Admin
Squidex is a content management hub or content management system (CMS), serving as a central place...
Tokens:139,619
Snippets:1,224
Trust Score:-
Update:2 days ago
Show doc for...
Tokens:
Raw
### Install dependencies with npm install

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/quick-start-guides/angular-blog-with-squidex.md

Installs the node modules and sets up the project after cloning. Must be run before starting the development server.

```bash
npm install
```

--------------------------------

### Run Squidex setup script

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-aws.md

Run this command after logging in to the EC2 instance to start the setup. It will ask for the domain and then start docker-compose, downloading and starting all images.

```bash
/opt/squidex/setup-squidex.sh
```

--------------------------------

### Post content using the contents property

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/java.md

Use the `contents` property to work with contents. The example builds a `ContentsPostContentRequest` with a data map and publishes it via `client.contents().postContent(schema.getName(), request)`.

```java
Map<String, Map<String, Object>> dataItem = new HashMap<>();
Map<String, Object> dataField = new HashMap<>();
dataItem.put("field1", dataField);
dataField.put("iv", id);

ContentsPostContentRequest request = ContentsPostContentRequest.builder()
    .body(dataItem)
    .publish(true)
    .build();
    
client.contents().postContent(schema.getName(), request);
```

--------------------------------

### Run docker-compose up -d

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/install-docker.md

Starts the Squidex docker-compose setup in detached mode. Requires the docker-compose.yml and .env files to be downloaded and configured first.

```bash
docker-compose up -d
```

--------------------------------

### Install Next.js with create-next-app

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/tutorials/building-a-nextjs-blog-with-squidex.md

Run this command to create a new Next.js project named 'squidex-blog'. If prompted to confirm installation of the create-next-app package, type 'y' and press enter.

```bash
npx create-next-app squidex-blog
```

--------------------------------

### Enter project directory and start development server

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/tutorials/building-a-nextjs-blog-with-squidex.md

Run these commands to enter the 'squidex-blog' directory and start the Next.js development server. The server runs at http://localhost:3000 and should display 'Welcome to Next.js'.

```bash
cd squidex-blog
yarn dev
```

--------------------------------

### Install .NET SDK in Official Docker Image

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/troubleshooting-and-support/diagnose-runtime-issues.md

Steps to install the .NET SDK in the official Docker image, which typically only has the runtime installed. Downloads the installer, adds permissions, and installs SDK version 5.0.

```bash
apk add wget

# Download DotnetSDK Installer
wget -O sdk_install.sh https://dot.net/v1/dotnet-install.sh

# Add permissions to file
chmod 777 sdk_install.sh

# Install sdk.
./sdk_install.sh -c 5.0
```

--------------------------------

### Example Kubernetes Copy Command

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/troubleshooting-and-support/diagnose-runtime-issues.md

Example of copying a dump file from a Kubernetes pod to a local file named full.dump.

```bash
kubectl cp squidex-123:/root/.dotnet/tools/core_20211101_160516 full.dump  
```

--------------------------------

### Set up MongoDB for development with Docker

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/developing.md

Clone the squidex-docker repository and start the development MongoDB container using docker-compose. Run these commands from your terminal after installing Docker.

```bash
git clone https://github.com/squidex/squidex-docker
cd squidex-docker/development
docker-compose up -d
```

--------------------------------

### Example Docker Copy Command

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/troubleshooting-and-support/diagnose-runtime-issues.md

Example of copying a dump file from a Docker container to a local file named full.dump.

```bash
docker cp squidex:/root/.dotnet/tools/core_20211101_160516 full.dump  
```

--------------------------------

### Install Squidex.CLI as a global dotnet tool

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Install the Squidex CLI from NuGet using the .NET tool installer. Requires the .NET SDK.

```bash
dotnet tool install --global Squidex.CLI
```

--------------------------------

### Install Docker on EC2 instance

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-aws-ec2.md

Install Docker using the official script and add the current user to the docker group. Logout and login again to apply the group changes.

```bash
# Install Docker
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh

# Add current user to docker group
sudo usermod -aG docker $USER
```

--------------------------------

### Handle errors with ApiError exception

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/java.md

The SDK uses exceptions for error handling. This example catches `ApiError` and checks `statusCode() == 400` to handle a likely duplicate app, otherwise rethrows the exception.

```java
try {
    client.client().apps().postApp(
        CreateAppDto.builder()
            .name("my-app")
            .build());
} catch (ApiError ex) {
    if (ex.statusCode() == 400) {
        System.out.println("App probably already exists.");
        return;
    } else {
        throw ex;
    }
}
```

--------------------------------

### reference Tag Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/liquid.md

Resolves a content by ID and saves it as a variable. The example iterates over references and outputs fields.

```text
// Input


{% raw %}
{% for id in event.data.references.iv %}
   {% reference 'ref', id %}
   Text: {{ ref.data.field1.iv }} {{ ref.data.field2.iv }} {{ ref.id }}
{% endfor %}
{% endraw %}



// Output
Text: Content1_Field1 Content1_Field2 Content1_ID
Text: Content2_Field1 Content2_Field2 Content1_ID
```

--------------------------------

### Create a schema using the schemas property

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/java.md

Use the `schemas` property on the client to create a schema. The example builds a `CreateSchemaDto` with a field and publishes it, then posts it via `client.schemas().postSchema(request)`.

```java
CreateSchemaDto request = CreateSchemaDto.builder()
    .name("my-schema")
    .fields(Collections.singletonList(
        UpsertSchemaFieldDto.builder()
            .name("field1")
            .properties(
                FieldPropertiesDto.string(
                    StringFieldPropertiesDto.builder()
                    .build()))
                .build()))
    .isPublished(true)
    .build();

SchemaDto createdSchema = client.schemas().postSchema(request);
```

--------------------------------

### Verify all resources

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-kubernetes.md

Lists all objects created by the Helm chart to verify the deployment.

```bash
kubectl get all
```

--------------------------------

### View deployment logs

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-kubernetes.md

Shows logs for the Squidex deployment, useful for troubleshooting.

```bash
kubectl logs deployment/squidex-squidex7
```

--------------------------------

### Install dotnet-gcdump Global Tool

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/troubleshooting-and-support/diagnose-runtime-issues.md

Commands to install the dotnet-gcdump global tool. The process must be run directly from the dotnet folder to use the SDK.

```bash
# Go to the dotnet folder. In order to use SDK the process needs to be run directly
cd /root/.dotnet

# install dotnet gcdump or install dotnet-dump to get a full dump
./dotnet tool install --global dotnet-gcdump 

# Go to the tools folder
cd tools
```

--------------------------------

### asset Tag Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/liquid.md

Resolves an asset by ID and saves it as a variable. The example iterates over assets and outputs file name and ID.

```text
// Input


{% raw %}
{% for id in event.data.assets.iv %}
   {% asset 'ref', id %}
   Text: {{ ref.fileName }} {{ ref.id }}
{% endfor %}
{% endraw %}

// Output
Text: Asset1_FileName Asset1_ID
Text: Asset2_FileName Asset2_ID
```

--------------------------------

### Install SDK with yarn

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/typescript.md

Alternative installation command using yarn for the @squidex/squidex package.

```bash
yarn add @squidex/squidex
```

--------------------------------

### Install Squidex v7 with Helm

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-kubernetes.md

Installs version 7 of Squidex with a custom domain. Replace 'squidex.your.domain' with your actual domain.

```bash
helm install squidex squidex/squidex7 --set env.URLS__BASEURL=https://squidex.your.domain --set ingress.hostName=squidex.your.domain
```

--------------------------------

### OData Query with $top, $skip, and $search

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Example of an OData query URL for content items. OData query options start with a dollar character (e.g., $filter). This example uses $top, $skip, and $search for pagination and full-text search.

```http
https://.../api/content/the-foodcrunch-mag/startups?$top=30&$skip=10&$search=delivery
```

--------------------------------

### Skip and Limit Combined (OData and JSON)

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Example of `skip` combined with `top`/`take` to read data page by page.

```markup
https://.../api/content/the-foodcrunch-mag/startups?$skip=20&$top=30
```

```javascript
{
    "skip": 20,
    "take": 30
}
```

--------------------------------

### Install next-mdx-remote with yarn

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/tutorials/building-a-nextjs-blog-with-squidex.md

Installs the next-mdx-remote package for parsing and rendering markdown content in the Next.js app.

```bash
yarn add next-mdx-remote
```

--------------------------------

### Example missing and unused keys output

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/translating.md

Sample output from the translation tool showing missing and unused keys. Use this to identify keys that need to be added or removed.

```text
Missing keys:
* new_KEY1
* new_KEY2

Unused keys:
* old_KEY1
* old_KEY2

```

--------------------------------

### Filter Examples

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Examples of filter expressions for querying content items, showing OData and JSON syntax for various operators and data types.

```APIDOC
## Filter Examples

### Description
Examples of filter expressions for querying content items, showing OData and JSON syntax for various operators and data types.

### OData Examples

#### Empty Check
```
$filter=empty(data/founders/iv)
$filter=empty(data/founders/iv) eq true
$filter=empty(data/founders/iv) eq false // Not empty
$filter=not empty(data/founders/iv)      // Not empty
```

#### Date Equality
```
$filter=created eq 2023-01-19T12:00:00Z
```

#### Date In List
```
$filter=created in ('2023-01-19T12:00:00Z', '2022-01-19T12:00:00Z')
```

#### ID Equality
```
$filter=id eq B5FE25E3-...
```

#### ID In List
```
$filter=id in (B5FE25E3-..., 311DD333-...)
```

#### String Equality
```
$filter=data/name/iv eq 'Uber Eats'
```

#### Boolean Equality
```
$filter=data/givenUp/iv eq true
```

#### Number Equality
```
$filter=data/funding/iv eq 500
```

#### String Functions
```
$filter=startswith(data/founded/iv, '202')
$filter=startswith(data/founded/iv, '202') eq true // Equivalent
---
$filter=endswith(data/founded/en, '022')
---
$filter=contains(data/description/en, 'catering')
```

#### Regex Matching
```
$filter=matchs(data/name/iv, 'a-z') // Case insensitive
---
$filter=matchs(data/name/iv, '/a-z/') // Case sensitive
---
$filter=matchs(data/name/iv, '/a-z/i') // Case insensitive
```

#### Negation
```
$filter=contains(data/name/iv, 'Uber Eats') eq false
---
not contains(data/name/iv, 'Uber Eats')
```

### JSON Examples

#### Empty Check
```json
{
    "filter": {
        "not": {
            "path": "data.founders.iv",
            "op": "empty"
        }
    }
}
{
    "filter": {
        "path": "data.founders.iv",
        "op": "empty"
    }
}
```

#### Date Equality
```javascript
{
   "filter": {
      "path": "created ",
      "op": "eq"
      "value": "2023-01-19T12:00:00Z"
   }
}
```

#### Date In List
```javascript
{
   "filter": {
      "path": "created ",
      "op": "in"
      "value": [
         "2023-01-19T12:00:00Z",
         "2022-01-19T12:00:00Z"
      }
   }
}
```

#### ID Equality
```javascript
{
    "filter": {
        "path": "id",
        "op": "eq",
        "value": "B5FE25E3-..."
    }
}
```

#### ID In List
```javascript
{
    "filter": {
        "path": "id",
        "op": "eq",
        "value": [
            "B5FE25E3-...",
            "311DD333-..."
        }
    }
}
```

#### String Equality
```javascript
{
    "filter": {
        "path": "data.name.iv",
        "op": "eq",
        "value": "Uber Eats"
    }
}
```

#### Boolean Equality
```javascript
{
    "filter": {
        "path": "data.givenUp.iv",
        "op": "eq",
        "value": true
    }
}
```

#### Number Equality
```javascript
{
    "filter": {
        "path": "data.funding.iv",
        "op": "eq",
        "value": 500
    }
}
```

#### String Functions
```javascript
{
    "filter": {
        "path": "data.founded.iv",
        "op": "startsWith",
        "value": "202"
    }
}
---
{
    "filter": {
        "path": "data.founded.en",
        "op": "endsWith",
        "value": "022"
    }
}
---
{
    "filter": {
        "path": "data.description.en",
        "op": "contains",
        "value": "delivery"
    }
}
```

#### Regex Matching
```json
{
    "filter": {
        "path": "data.name.iv",
        "op": "matchs",
        "value": "a-z" // Case insensitive
    }
}
---
{
    "filter": {
        "path": "data.name.iv",
        "op": "matchs",
        "value": "/a-z/" // Case sensitive
    }
}
---
{
    "filter": {
        "path": "data.name.iv",
        "op": "matchs",
        "value": "/a-z/i" // Case insensitive
    }
}
```

#### Negation
```javascript
{
    "filter": {
        "not": {
            "path": "data.name.iv",
            "op": "contains",
            "value": "Uber Eats"
        }
    }
}
```

### Notes
- **contains**, **startsWith** and **endsWith** are always case insensitive.
- In OData, operators can be compared with **false** for negation. In JSON, use a **not** operation.
```

--------------------------------

### Install SDK with npm

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/typescript.md

Install the @squidex/squidex package from the npm registry. The SDK has no peer dependencies and will add/install all required packages.

```bash
npm install @squidex/squidex --save
```

--------------------------------

### Filter by Stage (OData and JSON)

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Filter to find startups in the 'Seed' stage. Note: the JSON example is missing a comma after the `op` field.

```markup
https://.../api/content/the-foodcrunch-mag/startups?$filter=data/stage/iv eq Seed
```

```javascript
{
   "filter": {
      "path": "data.stage.iv",
      "op": "eq"
      "value": "Seed"
   }
}
```

--------------------------------

### Install windows-build-tools for node-sass

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/building.md

On Windows, run PowerShell or CMD.exe in elevated mode (Run as Administrator) to install the required build tools for node-sass.

```bash
npm install --global --production windows-build-tools
```

--------------------------------

### Add Squidex SDK dependency in build.gradle

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/java.md

Add the io.squidex:squidex dependency to a Gradle build file to install the Java SDK.

```groovy
dependencies {
    implementation 'io.squidex:squidex:1.0.0'
}
```

--------------------------------

### Add Squidex SDK dependency in pom.xml

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/java.md

Add the io.squidex:squidex dependency to a Maven pom.xml file to install the Java SDK.

```xml
<dependency>
    <groupId>io.squidex</groupId>
    <artifactId>squidex</artifactId>
    <version>1.0.0</version>
</dependency>// Some code
```

--------------------------------

### Clone Squidex Identity repository

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/install-identity.md

Clones the Squidex Identity repository from GitHub.

```bash
git clone https://github.com/Squidex/squidex-identity.git
```

--------------------------------

### Example content item structure for the startups schema

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Shows the JSON structure of a content item in the Squidex API for the 'startups' schema. Each field is wrapped in an object with a partition key ('iv' for invariant, language codes for localizable fields).

```javascript
{
    "id": "7802056f",
    "created": "2022-12-31T08:00:52Z",
    "createdBy": ".....",
    "lastModified": "2023-01-09T19:29:05Z",
    "lastModifiedBy": ".....",
    "data": {
        "slug": {
            "iv": "foodco"
        },
        "name": {
            "iv": "FoodCo"
        },
        "description": {
            "en": "FoodCo aims to revolutionize the way we eat. Their innovative products focus on sustainability.",
            "de": "FoodCo zielt darauf ab, die Art und Weise, wie wir essen, zu revolutionieren. Ihre innovativen Produkte setzen auf Nachhaltigkeit.",
            "it": null,
            "sv": "FoodCo har som mål att revolutionera vårt sätt att äta. Deras innovativa produkter fokuserar på hållbarhet."
        },
        "stage": {
            "iv": "Early"
        },
        "founded": {
            "iv": 2019
        },
        "funding": {
            "iv": 234
        },
        "founders": {
            "iv": [
                {
                    "name": "John Doe",
                    "position": null
                }
            ]
        },
        "tags": {
            "iv": [
                "sustainability"
            ]
        },
        "location": {
            "iv": {
                "latitude": 32.0237703,
                "longitude": -92.0390231
            }
        },
        "metadata": {
            "iv": null
        },
        "givenUp": {
            "iv": null
        }
    }
}
```

--------------------------------

### Filter by Funding Less Than (OData and JSON)

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Filter to find startups with funding less than 10 million USD.

```markup
https://.../api/content/the-foodcrunch-mag/startups?$filter=data/funding/iv lt 10
```

```javascript
{
   "filter": {
      "path": "data.funding.iv",
      "op": "lt"
      "value": 10
   }
}
```

--------------------------------

### Install the PHP SDK with Composer

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/php.md

Install the Squidex PHP SDK via Composer. The package is available on Packagist as @squidex/squidex.

```sh
compose install @squidex/squidex
```

--------------------------------

### Add the Helm repository

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-kubernetes.md

Adds the Squidex Helm repository using the name 'squidex'.

```bash
helm repo add squidex https://squidex.github.io/squidex/helm/
```

--------------------------------

### Verify Docker installation

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-aws-ec2.md

Check that Docker commands run without sudo after logging out and back in.

```bash
docker --version
```

--------------------------------

### Create sample configuration files with sync new

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Creates a new folder with sample configuration files that can be imported to the App. Files starting with double underscore are ignored during synchronization, so rename or copy them to sync.

```bash
.\sq.exe sync new <folder>
```

--------------------------------

### Get Random Items with random (OData and JSON)

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Use the `random` option to get random items. The random operator picks elements from the result set, not the entire database.

```markup
https://.../api/content/the-foodcrunch-mag/startups?$random=5
```

```json
{
    "random": 5
}
```

--------------------------------

### Create Content Using the contents Property

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/php.md

Use the contents property to create content. The example posts content with a single field value.

```php
$data = [
    'field1' => [
        'iv' => 'My Value'
    ]
];
    
$createdContent = $this->client->contents()->postContent(static::$schema->getName(), $data);
```

--------------------------------

### Connect to Docker Container with docker exec

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/troubleshooting-and-support/diagnose-runtime-issues.md

Use this command to get a shell to a running Squidex container. If you have built a custom image, bash might not be installed.

```bash
command docker exec -it <container name> /bin/bash
```

--------------------------------

### Clone the React.js sample blog repository

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/quick-start-guides/react.js-blog-with-squidex.md

Clones the starter code for the React.js blog sample from GitHub. Required before setting up environment variables and running locally.

```bash
git clone https://github.com/sangramrath/squidex-reactjs-blog-starter.git
```

--------------------------------

### Display Name Attribute

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/extensions/how-to-write-custom-rule-actions.md

Sets an optional label for a configuration property in the Management UI.

```csharp
[Display(Name = "My Name")]
```

--------------------------------

### Clone the Vue.js sample blog repository

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/quick-start-guides/vue.js-blog-with-squidex.md

Clones the starter repository for the Vue.js blog sample code to your local machine.

```bash
git clone https://github.com/sangramrath/squidex-vuejs-blog-starter.git
```

--------------------------------

### Instantiate SquidexClient

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/java.md

Create a SquidexClient instance with app name, client ID, client secret, and optional URL. The url parameter is optional when using Squidex Cloud.

```java
SquidexClient squidex = SquidexClient.builder()
    .appName("my-app")
    .clientId("your-app:default")
    .clientSecret("xxx")
    .url("https://your.squidex-deployment")
    .build();
```

--------------------------------

### Get Random Items (random)

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Returns random items from the result set (not from the entire database). The random operator picks elements from the result set.

```APIDOC
## [GET] /api/content/{app}/startups?$random=5

### Description
Returns random items from the result set (not from the entire database). The random operator picks elements from the result set.

### Method
GET

### Endpoint
`/api/content/{app}/startups?$random=5`

### Parameters
#### Query Parameters
- **$random** (integer) - Optional - Number of random items to return.

### Request Example
```markup
https://.../api/content/the-foodcrunch-mag/startups?$random=5
```

### Response
#### Success Response (200)
- **items** (array) - List of random content items.

#### Response Example
```json
{
  "items": []
}
```
```

```APIDOC
## [POST] /api/content/{app}/startups

### Description
Returns random items from the result set (not from the entire database). The random operator picks elements from the result set.

### Method
POST

### Endpoint
`/api/content/{app}/startups`

### Parameters
#### Request Body
- **random** (integer) - Optional - Number of random items to return.

### Request Example
```json
{
  "random": 5
}
```

### Response
#### Success Response (200)
- **items** (array) - List of random content items.

#### Response Example
```json
{
  "items": []
}
```
```

--------------------------------

### Run Squidex Backend with dotnet

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/developing.md

Starts the backend application. Requires `ASPNETCORE_ENVIRONMENT` set to `Development` via `launchSettings.json` or IDE settings. Access the app at https://localhost:5001.

```bash
cd backend
cd src/Squidex
dotnet restore # Install all dependencies
dotnet run
```

--------------------------------

### Check rollout status

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-kubernetes.md

Checks the status of the deployment rollout. It may take a few minutes before the rollout is successful.

```bash
kubectl rollout status deployments
```

--------------------------------

### Run Squidex with Docker Compose

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-aws-ec2.md

Start Squidex with NGINX and MongoDB using the docker-compose-nginx.yml file. The -f flag is mandatory to specify the compose file.

```bash
docker compose -f docker-compose-nginx.yml up -d
```

--------------------------------

### md5 Filter Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/liquid.md

Calculates the MD5 hash from a given string. Use for hashing passwords when backwards compatibility is important.

```text
{{event.data.password.iv | md5}}
```

--------------------------------

### Clone the Angular sample blog repository

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/quick-start-guides/angular-blog-with-squidex.md

Clones the starter code for the Angular blog from GitHub. Required before setting up environment variables and running locally.

```bash
git clone https://github.com/sangramrath/squidex-angular-blog-starter.git
```

--------------------------------

### Filter by Funding Greater Than (OData and JSON)

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Filter to find startups with funding greater than 100 million USD.

```markup
https://.../api/content/the-foodcrunch-mag/startups?$filter=data/funding/iv gt 100
```

```javascript
{
   "filter": {
      "path": "data.funding.iv",
      "op": "gt"
      "value": 100
   }
}
```

--------------------------------

### Clone Squidex source code from GitHub

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/extensions/README.md

Checkout the Squidex source code from GitHub to start developing custom plugins.

```bash
git@github.com:Squidex/squidex.git
```

--------------------------------

### Run Angular app in development mode with npm start

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/quick-start-guides/angular-blog-with-squidex.md

Compiles and runs the Angular app in development mode, serving it at http://localhost:4200/. Supports hot-reload for live changes.

```bash
npm start
```

--------------------------------

### Create Layout component in layout.js

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/tutorials/building-a-nextjs-blog-with-squidex.md

Create a 'components' folder in 'squidex-blog' and add this file as 'components/layout.js'. It provides a header and footer with a link to the blog's homepage, and uses the 'children' prop to embed page content.

```jsx
import Link from "next/link";

export default function Layout({ children }) {
  return (
    <div className="container">
      <div className="header">
        <Link href="/">
          <a className="blog-heading">My Blog</a>
        </Link>
      </div>
      {children}
      <div className="footer">
        <div>My Blog</div>
        <div>(c) 2022 </div>
      </div>
    </div>
  );
}
```

--------------------------------

### Instantiate SquidexClient with Configuration

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/php.md

Create a SquidexClient instance using Configuration. The host parameter is optional for Squidex Cloud. Requires the Composer autoloader.

```php
use Squidex\Client\Configuration;
use Squidex\Client\SquidexClient;

require_once __DIR__ . '/../vendor/autoload.php';

$config = new Configuration();
$config->setClientId('client-id');
$config->setClientSecret('client-secret');
$config->setAppName('my-app');
$config->setHost('https://cloud.squidex.io');

$client = new SquidexClient($config);
```

--------------------------------

### Negations - OData

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Example of a negation using 'not' with endswith.

```plaintext
not endswith(data/name/iv, 'Food')
```

--------------------------------

### Create MongoDB container instance with Azure CLI

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-azure.md

Run this command to create a MongoDB container instance on Azure. Requires your resource group, storage account name, and storage account key. The command mounts the etc-squidex-mongodb file share and starts MongoDB with authentication.

```bash
az container create --resource-group [YOUR_RESOURCE_GROUP] --name mongodb --image mongo --azure-file-volume-account-name [YOUR_STORAGE_ACCOUNT] --azure-file-volume-account-key "[YOUR_STORAGE_KEY]" --azure-file-volume-share-name etc-squidex-mongodb --azure-file-volume-mount-path "/data/mongoaz" --ports 27017 --cpu 2 --ip-address public --memory 2 --os-type Linux --protocol TCP --command-line "mongod --dbpath=/data/mongoaz --bind_ip_all --auth"
```

--------------------------------

### Combining conditions - OData

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Examples of AND and OR conditions. Both conditions must be true for AND, one for OR.

```plaintext
// AND: Both condition must be true
$filter=data/funding/iv eq 100 and data/givenUp/iv eq true 

// OR: One condition must be true
$filter=data/funding/iv eq 100 or data/givenUp/iv eq true 
```

--------------------------------

### List all configurations with sq.exe config list

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Displays all stored configurations. Use the -t or --table flag to view them in a table format.

```powershell
.\sq.exe config list
```

--------------------------------

### Example 1: Handle Command - MyHandler

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/extensions/README.md

Handles a command by checking its type, processing it, and calling Complete() to stop the pipeline. If the command is not of the expected type, it calls next() to continue.

```csharp
class MyHandler : ICustomCommandMiddleware
{
    public async Task HandleAsync(CommandContext context, Func<Task> next) 
    {
        if (context.Command is MyCommand myCommand)
        {
            await Handle(myCommand);
            context.Complete();
        }
        else
        {
            await next();
        }
    }
}
```

--------------------------------

### View sync in flags with --help

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Displays a list of supported flags/options for the `sync in` command, such as `app`, `targets`, `language`, `content-action`, `delete`, `patch-content`, `recreate`, `skip-assets`, `update-current-client`, and `emulate`.

```bash
.\sq.exe sync in --help
```

--------------------------------

### Create a backup

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Creates a backup using the 'backup' command. Requires a client with the Owner role.

```bash
.\sq.exe backup create backup.zip
```

--------------------------------

### Show content import help

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Displays the help section for the `content import` command, listing all available options.

```bash
.\sq.exe content import --help
```

--------------------------------

### Switch to another configuration with sq.exe config use

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Selects an App configuration from the list of configurations, useful when working with multiple Apps.

```powershell
.\sq.exe config use [APP_NAME]
```

--------------------------------

### JSON empty filter examples

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

JSON filter expressions for checking if a field is empty or not empty. The 'not' operation negates the filter expression.

```JSON
{
    "filter": {
        "not": {
            "path": "data.founders.iv",
            "op": "empty"
        }
    }
}
    "filter": {
        "path": "data.founders.iv",
        "op": "empty"
    }
}
```

--------------------------------

### Build Squidex with Docker (manual deployment)

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/building.md

Builds the Squidex image, creates a container, copies the output to ./publish, and cleans up. Recommended to give the Docker machine at least 4GB of memory.

```bash
# Build the image
docker build . -t squidex-build-image

# Create the container
docker create --name squidex-build-container squidex-build-image

# Copy the output to the host file system
docker cp squidex-build-container:/app/. ./publish

# Cleanup
docker rm squidex-build-container
docker rmi squidex-build-image
```

--------------------------------

### editor.onInit(cb)

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/editors.md

Register a function that is invoked when the messaging communication with the management UI is established. After the callback is invoked you get retrieve values with the get methods. The context object will be passed to the callback.

```APIDOC
## editor.onInit(cb)

### Description
Register a function that is invoked when the messaging communication with the management UI is established. After the callback is invoked you get retrieve values with the get methods. The context object will be passed to the callback.

### Method
`editor.onInit(cb)`

### Parameters
- **cb** (function) - Required - Callback function to be invoked when communication is established.

### Returns
None
```

--------------------------------

### Various conditions - OData

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Examples of comparison operators: ne, eq, lt, le, gt, ge. Each line shows a filter with a comment indicating the operator.

```plaintext
$filter=data/funding/iv ne 100 // Not equals
---
$filter=data/funding/iv eq 100 // Equals
---
$filter=data/funding/iv lt 100 // Less than
---
$filter=data/funding/iv le 100 // Less or equals than
---
$filter=data/funding/iv gt 100 // Greater than
---
$filter=data/funding/iv ge 100 // Greater or equals than
```

--------------------------------

### Replace squidex-blog/pages/index.js with initial Home component

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/tutorials/building-a-nextjs-blog-with-squidex.md

Initial content for the Next.js home page. It renders a Head component with the blog title and favicon. Replace the existing content of squidex-blog/pages/index.js with this code.

```jsx
import Head from "next/head";

export default function Home() {
  return (
    <div>
      <Head>
        <title>My blog</title>
        <link rel="icon" href="/favicon.ico" />
      </Head>
    </div>
  );
}
```

--------------------------------

### CLI help for a specific feature (config)

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Use --help after a feature to list all commands supported by that feature. Example shows the config feature.

```powershell
.\sq.exe config --help
```

--------------------------------

### Random Items with Limit (OData and JSON)

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Returns 5 random items from the first 200 elements with default order. Note the JSON example contains a typo (`%%&%`).

```markup
https://.../api/content/the-foodcrunch-mag/startups?$random=5&$top=200
```

```json
{
    "random": 5,
    "take": 200%%&% 
}
```

--------------------------------

### Connect to EC2 instance via SSH

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-aws.md

Use this command to connect to the EC2 instance after it is launched. Replace 'path/to/keypair.pem' with the path to your key pair and '[PUBLIC IP]' with the instance's public IPv4 address.

```bash
ssh -i path/to/keypair.pem ubuntu@[PUBLIC IP]
```

--------------------------------

### Webhook Request Body Example

Source: https://github.com/squidex/squidex-docs2/blob/master/05-integrated/rules.md

Example JSON payload sent by Squidex to a webhook endpoint when a rule is triggered. The payload contains event metadata such as type, content data, schema ID, and app ID.

```json
{
   "type":"GreetingsCreated",
   "payload":{
      "$type":"EnrichedContentEvent",
      "type":"Created",
      "id":"39885f2a-0393-4c8f-ae48-5add0de0b0ef",
      "created":"2019-05-07T17:27:55Z",
      "lastModified":"2019-05-07T17:27:55Z",
      "createdBy":"subject:5cc82941de5c0c5aa46c9f04",
      "lastModifiedBy":"subject:5cc82941de5c0c5aa46c9f04",
      "data":{
         "text":{
            "iv":"Hello Squidex"
         }
      },
      "status":"Draft",
      "schemaId":"d5ebc338-4ce7-4c9e-a9c1-6f41b2c0c854,greetings",
      "actor":"subject:5cc82941de5c0c5aa46c9f04",
      "appId":"4111766f-4ae5-4831-9ce6-e89b5eb530a8,test2",
      "timestamp":"2019-05-07T17:27:55Z",
      "name":"GreetingsCreated",
      "version":0
   },
   "timestamp":"2019-05-07T17:27:55Z"
}
```

--------------------------------

### OData empty filter examples

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

OData filter expressions for checking if a field is empty or not empty. The 'empty' operator can be used with 'eq true', 'eq false', or 'not empty' to test emptiness.

```OData
$filter=empty(data/founders/iv)
$filter=empty(data/founders/iv) eq true
$filter=empty(data/founders/iv) eq false // Not empty
$filter=not empty(data/founders/iv)      // Not empty
```

--------------------------------

### Build backend manually

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/building.md

Builds the backend of Squidex for manual deployment. Run from the backend directory; outputs to ../../../publish.

```bash
cd backend
cd src/Squidex
dotnet publish --configuration Release --output "../../../publish"
```

--------------------------------

### Run the Vue.js blog in development mode

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/quick-start-guides/vue.js-blog-with-squidex.md

Compiles and runs the Vue.js blog in development mode, serving the app at http://localhost:8080/ with hot-reload support.

```bash
npm run serve
```

--------------------------------

### JSON Query with q Parameter

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/api-overview/api.md

Example of a JSON query passed as a URL-encoded JSON object with the q query parameter. JSON queries are harder to read but faster to parse, and are used mainly for the UI.

```http
https://.../api/content/the-foodcrunch-mag/startups?q=%7B%22fullText%22%3A%22website%22%2C%22take%22%3A10%2C%22sort%22%3A%5B%5D%2C%22filter%22%3A%7B%22and%22%3A%5B%5D%7D%7
```

--------------------------------

### editor.getContext()

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/editors.md

Gets the current context information.

```APIDOC
## editor.getContext()

### Description
Gets the current context information.

### Method
`editor.getContext()`

### Parameters
None

### Returns
- The current context information.
```

--------------------------------

### editor.getValue()

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/editors.md

Gets the current value of the field.

```APIDOC
## editor.getValue()

### Description
Gets the current value of the field.

### Method
`editor.getValue()`

### Parameters
None

### Returns
- The current value of the field.
```

--------------------------------

### Show sync out command help

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Displays the help for the 'sync out' command, listing available flags such as 'app', 'targets', and 'describe'.

```bash
.\sq.exe sync out --help
```

--------------------------------

### Combined filters example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/simple.md

Demonstrates combining multiple filters (uppercase and escape) on a content field.

```plaintext
${CONTENT_DATA.CITY.en | uppercase | escape} 
```

--------------------------------

### Export configuration of specific app with sync out

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Exports the configuration of an App named 'blog-with-squidex' to the local machine where CLI is installed. The client must have the Owner role.

```bash
.\sq.exe sync out blog-with-squidex
```

--------------------------------

### Initial BlogPost component in [slug].js

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/tutorials/building-a-nextjs-blog-with-squidex.md

Placeholder component for the blog post page. It will be replaced with a component that renders the post content.

```jsx
export default function BlogPost() {
  return <div>Body</div>;
}
```

--------------------------------

### markdown2text Filter Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/liquid.md

Converts a Markdown string to plain text.

```text
{{event.data.body.iv | markdown2text}}
```

--------------------------------

### Show content export help

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Displays the help for the 'content export' command, listing all available options.

```bash
.\sq.exe content export --help
```

--------------------------------

### html2text Filter Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/liquid.md

Converts a HTML string to plain text.

```text
{{event.data.body.iv | html2text}}
```

--------------------------------

### List configurations as a table with sq.exe config list -t

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Shows configurations in a table format using the -t or --table flag.

```powershell
.\sq.exe config list -t
```

```powershell
.\sq.exe config list --table
```

--------------------------------

### escape Filter Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/liquid.md

Escapes a value to be a valid JSON string.

```text
{{event.user.name | escape}}
```

--------------------------------

### format_date Filter Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/liquid.md

Formats a date using a specified pattern.

```text
{{event.timestamp | format_date: 'yyyy-MM-dd-hh-mm-ss'}}
```

--------------------------------

### editor.isFullscreen()

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/editors.md

Get the current fullscreen state of the field form. Fullscreen on (true) or off (false).

```APIDOC
## editor.isFullscreen()

### Description
Get the current fullscreen state of the field form. Fullscreen on (true) or off (false).

### Method
`editor.isFullscreen()`

### Parameters
None

### Returns
- Boolean indicating if the field is in fullscreen mode.
```

--------------------------------

### Import configuration from folder to App with sync in

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/automation-tools.md

Synchronizes a configuration created through the CLI with your App. The client used by the CLI configuration must be the same as in the App.JSON file, otherwise the client will be deleted and consecutive commands will fail.

```bash
.\sq.exe sync in <folder>
```

--------------------------------

### editor.getLanguage()

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/editors.md

Get the language of the field editor. If the field is not localized the master language is passed through.

```APIDOC
## editor.getLanguage()

### Description
Get the language of the field editor. If the field is not localized the master language is passed through.

### Method
`editor.getLanguage()`

### Parameters
None

### Returns
- The language of the field editor.
```

--------------------------------

### Run Webpack Dev Server for Angular Frontend

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/developing.md

Starts the development server for the Angular frontend. Run `npm i` only the first time or when `project.json` changes. The server watches files and reloads the website automatically.

```bash
cd frontend # Go to the frontend
npm i # Install all dependencies, only needed the first time
npm start
```

--------------------------------

### editor.getFormValue()

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/editors.md

Gets the current value of the content form. Can be used to access the values of other fields.

```APIDOC
## editor.getFormValue()

### Description
Gets the current value of the content form. Can be used to access the values of other fields.

### Method
`editor.getFormValue()`

### Parameters
None

### Returns
- The current value of the content form.
```

--------------------------------

### Create Artifact Registry repository

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-gcp.md

Creates a Docker repository in Artifact Registry using the configured variables.

```bash
gcloud artifacts repositories create $ARTIFACT_REGISTRY_NAME --repository-format=docker --location=$REGION
```

--------------------------------

### Build frontend manually

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/building.md

Builds the frontend of Squidex for manual deployment. Run from the frontend directory; copies build output to ../publish/wwwroot/build.

```bash
cd frontend
npm i # Install npm packages
npm run build
copy build "../publish/wwwroot/build"
```

--------------------------------

### Enable Artifact Registry API

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/installation/platforms/install-on-gcp.md

Enables the Google Cloud Artifact Registry API, required before creating a repository.

```bash
gcloud services enable artifactregistry.googleapis.com
```

--------------------------------

### timestamp_sec Filter Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/liquid.md

Returns the number of seconds between 1970/1/1 and a given date.

```text
{{event.timestamp_sec | timestamp}}
```

--------------------------------

### timestamp Filter Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/developer-guides/rule-formatting/liquid.md

Returns the number of milliseconds between 1970/1/1 and a given date.

```text
{{event.timestamp | timestamp}}
```

--------------------------------

### Configure OkHttp timeouts for SquidexClient

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/software-development-kits/java.md

Create a custom OkHttpClient with connect, write, and read timeouts and pass it to SquidexClient. The default timeout is 30 seconds.

```java
OkHttpClient client = new OkHttpClient.Builder()
    .connectTimeout(10, TimeUnit.SECONDS)
    .writeTimeout(10, TimeUnit.SECONDS)
    .readTimeout(30, TimeUnit.SECONDS)
    .build();
        
SquidexClient squidex = SquidexClient.builder()
    ...
    .httpClient(client)
    .build();
```

--------------------------------

### X-Flatten Header Example

Source: https://github.com/squidex/squidex-docs2/blob/master/02-documentation/concepts/localization.md

Use the X-Flatten header to flatten fields that have only a single value, simplifying the response structure.

```javascript
X-Flatten: true
{ 
    ...,
    "data": {
        "description": {
            "en": "FoodCo aims to revolutionize the way we eat. Their innovative products focus on sustainability.",
            "fi": "FoodCo pyrkii mullistamaan ruokailutottumuksiamme. Niiden innovatiiviset tuotteet keskittyvät kestävään kehitykseen.",
            "it": null,
            "sv": "FoodCo har som mål att revolutionera vårt sätt att äta. Deras innovativa produkter fokuserar på hållbarhet."
        },
        "founded": 2019
        }
    }
}
```

--------------------------------

### Description Attribute

Source: https://github.com/squidex/squidex-docs2/blob/master/01-getting-started/contributing-and-developing/extensions/how-to-write-custom-rule-actions.md

Adds an optional description rendered after the input field.

```csharp
[Display(Description = "My Description.")]
```
Tokens:
Raw