Structr

https://github.com/structr/structr
Admin
Structr is a low-code development and runtime environment built on graph database technology for...
Tokens:142,136
Snippets:890
Trust Score:8.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install and Start Structr (version 6.0.0)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/1-Getting Started.md

Installs Structr version 6.0.0 using a Debian package. It involves downloading the .deb file, installing it using dpkg, and then starting the Structr service.

```bash
$ wget https://download.structr.com/repositories/releases/org/structr/structr/6.0.0/structr-6.0.0.deb
$ dpkg -i structr-6.0.0.deb
$ systemctl start structr
```

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

### Docker Setup for Structr

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/1-Getting Started.md

This snippet demonstrates how to set up and run Structr using Docker. It involves cloning a Docker setup repository, navigating into the directory, and then starting the Structr services with Docker Compose. This method is recommended for local development environments.

```bash
# Clone the Docker setup repository
git clone https://github.com/structr/docker-setup.git
cd docker-setup

# Start Structr with Docker Compose
docker-compose up -d

# Access Structr at http://localhost:8082/structr
```

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

### Install GraalVM for Structr (ARM Architecture)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/1-Getting Started.md

This code block details the installation of GraalVM on an ARM (aarch64) Linux system, required for manual Structr installations on such architectures. It includes downloading the GraalVM binaries, extracting them, placing them in the system's Java directory, and setting up the 'java' command using update-alternatives. URLs and version numbers may need adjustment based on your specific server setup.

```bash
$ wget https://download.oracle.com/graalvm/25/latest/graalvm-jdk-25_linux-aarch64_bin.tar.gz && tar xvf graalvm-jdk-25_linux-aarch64_bin.tar.gz && mkdir -p /usr/lib/jvm && mv graalvm-jdk-25+37.1 /usr/lib/jvm && update-alternatives --install /usr/bin/java java /usr/lib/jvm/graalvm-jdk-25+37.1/bin/java 25 && update-alternatives --auto java
```

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

### Structr Service Start Log Output

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/1-Getting Started.md

Example log output indicating a successful startup of Structr version 6.0.0. The logs show the HTTP service starting on port 8082 and the overall initialization completion.

```log
2025-09-24 12:33:20.695 [main] INFO  o.structr.rest.service.HttpService - Starting Structr (host=0.0.0.0:8082, maxIdleTime=1800, requestHeaderSize=8192)
2025-09-24 12:33:20.696 [main] INFO  o.structr.rest.service.HttpService - Base path ./
2025-09-24 12:33:20.697 [main] INFO  o.structr.rest.service.HttpService - Structr started at http://0.0.0.0:8082
2025-09-24 12:33:20.701 [main] INFO  org.eclipse.jetty.server.Server - jetty-12.0.23; built: 2025-07-02T14:02:02.445Z; git: 01a4119797e9cee53c974ae126cc316d0c8a533a; jvm 25+37-LTS-jvmci-b01
2025-09-24 12:33:20.770 [main] INFO  o.e.j.s.DefaultSessionIdManager - Session workerName=93118b0075dc8a19a6d487948fe5ddf7
2025-09-24 12:33:20.777 [main] INFO  o.e.j.server.handler.ContextHandler - Started oeje10s.ServletContextHandler@4c0d7878{ROOT,/,b=null,a=AVAILABLE,h=GzipHandler@5a349644{STARTED,min=256,inflate=32768}}
2025-09-24 12:33:20.788 [main] INFO  o.e.j.e.s.ServletContextHandler - Started oeje10s.ServletContextHandler@4c0d7878{ROOT,/,b=null,a=AVAILABLE,h=GzipHandler@5a349644{STARTED,min=256,inflate=32768}}
2025-09-24 12:33:20.789 [main] INFO  o.e.j.server.handler.ContextHandler - Started oejsh.ContextHandler@18dda2e1{/structr,/structr,b=null,a=AVAILABLE,h=osrs.HttpService$@3c0b9643{STARTED}}
2025-09-24 12:33:20.802 [main] INFO  o.e.jetty.server.AbstractConnector - Started ServerConnector@4bd29a01{HTTP/1.1, (http/1.1, h2c)}{0.0.0.0:8082}
2025-09-24 12:33:20.809 [main] INFO  org.eclipse.jetty.server.Server - Started oejs.Server@6e1d939e{STARTING}[12.0.23,sto=1000] @6888ms
2025-09-24 12:33:20.811 [main] INFO  org.structr.core.Services - 5 service(s) processed
2025-09-24 12:33:20.812 [main] INFO  org.structr.core.Services - Registering shutdown hook.
2025-09-24 12:33:20.826 [main] INFO  org.structr.core.Services - Started Structr 6.0.0 abcde 202510121210
2025-09-24 12:33:20.827 [main] INFO  org.structr.core.Services - ---------------- Initialization complete ---------------- 
```

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

### Install GraalVM for Structr (x64 Architecture)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/1-Getting Started.md

This code block provides instructions for installing GraalVM on an x64 (AMD64) Linux system, a prerequisite for manual Structr installation. It downloads the GraalVM binaries, extracts them, moves them to the appropriate directory, and configures system alternatives for the Java executable. Ensure you adapt download URLs and version strings as needed.

```bash
$ wget https://download.oracle.com/graalvm/25/latest/graalvm-jdk-25_linux-x64_bin.tar.gz && tar xvzf graalvm-jdk-25_linux-x64_bin.tar.gz && mkdir -p /usr/lib/jvm && mv graalvm-jdk-25+37.1 /usr/lib/jvm && update-alternatives --install /usr/bin/java java /usr/lib/jvm/graalvm-jdk-25+37.1/bin/java 25 && update-alternatives --auto java
```

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

### Configure and Start Neo4j Service

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/1-Getting Started.md

This section covers configuring Neo4j's memory settings and starting the service. It includes recommended initial heap and pagecache sizes for a server with 8GB RAM and commands to start and check the status of the Neo4j service.

```bash
# Edit /etc/neo4j/neo4j.conf and adjust memory settings:
# server.memory.heap.initial_size=1g
# server.memory.heap.max_size=1g
# server.memory.pagecache.size=2g

# Start Neo4j
systemctl start neo4j

# Check Neo4j status
systemctl status neo4j
```

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

### Install Neo4j Debian Package (version 5.26 LTS)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/1-Getting Started.md

Installs the Neo4j 5.26 LTS version on Debian-based systems. This involves adding the Neo4j repository key, configuring the repository source, updating the package list, and finally installing the Neo4j package.

```bash
$ wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo apt-key add -
$ echo 'deb https://debian.neo4j.com stable 5' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
$ apt update
$ apt -y install neo4j
```

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

### Install Neo4j Debian Package (latest version 2025.09.0)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/1-Getting Started.md

Installs the latest Neo4j version (2025.09.0) on Debian-based systems. This process includes importing the GPG key to a specific directory, configuring the repository with the signed-by option, updating the package list, and installing the specified Neo4j version.

```bash
$ wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/neotechnology.gpg
$ echo 'deb [signed-by=/etc/apt/keyrings/neotechnology.gpg] https://debian.neo4j.com stable latest' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
$ sudo apt-get update
$ apt -y install neo4j=1:2025.09.0
```

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

### Install mkcert and Generate Local Certificates

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Provides instructions for installing mkcert on macOS and Ubuntu, creating a local Certificate Authority (CA), and then generating locally-trusted SSL certificates for 'localhost', '127.0.0.1', and '::1'. The generated certificates are then moved to the Structr SSL directory.

```bash
# Install mkcert
brew install mkcert  # macOS
# or
sudo apt install mkcert  # Ubuntu

# Create local CA
mkcert -install

# Generate certificate for localhost
mkcert localhost 127.0.0.1 ::1

# Move certificates to Structr
sudo mkdir -p /opt/structr/ssl/
sudo mv localhost+2.pem /opt/structr/ssl/localhost-cert.pem
sudo mv localhost+2-key.pem /opt/structr/ssl/localhost-key.pem
```

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

### Troubleshoot Java Version Conflicts for Structr

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/1-Getting Started.md

Provides steps to resolve issues where Structr fails to start due to conflicting Java versions. It includes checking the current Java version, identifying CPU architecture, and using `update-alternatives` to select the correct Java JDK.

```bash
# Check current Java version
java -version

# Check server architecture
uname -a

# Configure Java alternatives (example selecting option 1)
update-alternatives --config java
# (Press '1' to select GraalVM JDK 25)

# Restart Structr after configuring Java
systemctl start structr
```

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

### Install GraalVM 22.1.0 on Linux

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/8-Structr 4.x Migration Notes.md

Installs GraalVM 22.1.0, the required Java Runtime for Structr 5.x, on Linux-based distributions. This involves downloading the archive, extracting it, moving it to the JVM directory, and updating system alternatives for Java.

```shell
wget https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-22.1.0/graalvm-ce-java11-linux-amd64-22.1.0.tar.gz
tar xvzf graalvm-ce-java11-linux-amd64-22.1.0.tar.gz
sudo mv graalvm-ce-java11-22.1.0 /usr/lib/jvm
sudo update-alternatives --install /usr/bin/java java /usr/lib/jvm/graalvm-ce-java11-22.1.0/bin/java 2210
sudo update-alternatives --auto java
```

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

### Verify Structr Configuration Settings

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Uses grep to search the Structr configuration file for lines containing 'https', 'ssl', or 'letsencrypt'. This helps verify that relevant security and SSL settings are present.

```bash
grep -E "(https|ssl|letsencrypt)" /opt/structr/structr.conf
```

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

### Manual View Selection (info) with Curl

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/1-Backend.md

This example shows how to retrieve data using the 'info' view via a curl command. It sends a GET request to the specified resource, including authentication headers and sorting parameters, to get the detailed project information.

```shell
$ curl -s -HX-User:admin -HX-Password:admin http://localhost:8082/structr/rest/Project/info?_sort=name
```

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

### Configure Structr to Use Self-Signed Certificates

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

These are configuration settings for Structr, not executable code. They enable HTTPS on a specific port and provide the file paths to the self-signed SSL certificate and private key.

```properties
# In Server Settings
application.https.enabled = true
application.https.port = 8443
application.ssl.certificate.path = /opt/structr/ssl/localhost-cert.pem
application.ssl.private.key.path = /opt/structr/ssl/localhost-key.pem
```

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

### Configure Let's Encrypt Domain

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Sets the domain name(s) for which Let's Encrypt certificates will be generated. For production, use your actual domain. Multiple domains can be specified, separated by commas. This configuration is crucial for enabling automatic SSL certificate management.

```properties
letsencrypt.domains = localhost
```

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

### Monitor Structr Real-time Logs

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Uses journalctl to follow the real-time logs of the Structr service. The '-f' flag allows for live monitoring of new log entries.

```bash
sudo journalctl -u structr -f
```

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

### Restart Structr HTTP Service via Command Line

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Provides commands to restart the Structr service or specifically the HTTP service using systemctl or a REST API call. This is necessary after configuration changes to apply them. Requires SSH access or administrative credentials.

```bash
# Restart Structr service
sudo systemctl restart structr

# Or restart just the HTTP service via API
curl -XPOST -HX-User:admin -HX-Password:admin \
  http://localhost:8082/structr/rest/maintenance/restartService \
  -d '{"serviceName":"HttpService"}'
```

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

### Configure HTTP and HTTPS Ports

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Sets the default ports for HTTP and HTTPS traffic. Port 80 is standard for HTTP and required for Let's Encrypt's HTTP-01 challenge. Port 443 is the standard for HTTPS. Ensure these ports are accessible and not blocked by firewalls.

```properties
application.http.port = 80
application.https.port = 443
```

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

### Backup Structr SSL Certificate Files

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Creates a compressed tar archive of the Structr SSL certificate files located in '/opt/structr/ssl/'. The backup file is named with the current date. A corresponding restore command is also provided.

```bash
sudo tar -czf /backup/structr-ssl-$(date +%Y%m%d).tar.gz /opt/structr/ssl/

# Restore from backup (if needed)
sudo tar -xzf /backup/structr-ssl-YYYYMMDD.tar.gz -C /
```

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

### Force Manual Let's Encrypt Renewal

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Initiates a manual renewal process for Let's Encrypt certificates via the Structr REST API. Requires admin credentials and specifies the server environment and challenge type.

```bash
curl -XPOST -HX-User:admin -HX-Password:admin \
  http://localhost/structr/rest/maintenance/letsencrypt \
  -d '{"server":"production","challenge":"http","wait":"10"}'
```

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

### Check Structr Service Status

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Uses systemctl to check the current status of the Structr service. This is useful for diagnosing whether the service is running, stopped, or in an error state.

```bash
sudo systemctl status structr
```

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

### Configure Structr Security Headers

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

These are configuration settings for Structr, not executable code. They enable and configure various security headers like HSTS, CSP, X-Frame-Options, and XSS protection to enhance the application's security.

```properties
# In Server Settings
application.security.headers.enabled = true
application.security.headers.hsts = true
application.security.headers.csp = true
application.security.headers.xframe = DENY
application.security.headers.xss = 1; mode=block
```

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

### Harden Structr SSL Configuration

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

These are configuration settings for Structr, not executable code. They specify the allowed SSL/TLS protocols (TLSv1.2, TLSv1.3) and a strong set of cipher suites, along with the Diffie-Hellman key size, to improve the security of HTTPS connections.

```properties
# Disable weak protocols and ciphers
application.ssl.protocols = TLSv1.2,TLSv1.3
application.ssl.ciphers = ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256
application.ssl.dh.keysize = 2048
```

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

### Fetch Projects (Example Response)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/1-Backend.md

This section shows an example of the JSON response when fetching project data. It includes project details, tasks, and metadata about the query.

```APIDOC
## GET /structr/rest/Project

### Description
Retrieves a list of projects from the Structr database. The response includes detailed information for each project, such as its ID, name, tasks, description, owner, and priority. It also contains metadata about the query execution like query time and result count.

### Method
GET

### Endpoint
/structr/rest/Project

### Parameters
#### Query Parameters
- **_outputNestingDepth** (integer) - Optional - Adjusts the output depth of the result JSON. Defaults to 3.

### Request Example
```
GET /structr/rest/Project?_outputNestingDepth=5
```

### Response
#### Success Response (200)
- **result** (array) - An array of project objects.
  - **id** (string) - The unique identifier for the project.
  - **type** (string) - The type of the object, always "Project".
  - **name** (string) - The name of the project.
  - **tasks** (array) - A list of tasks associated with the project.
  - **description** (string) - A detailed description of the project.
  - **owner** (object | null) - The owner of the project (can be null).
  - **priority** (integer) - The priority level of the project.
- **query_time** (string) - The time taken to execute the query.
- **result_count** (integer) - The total number of results.
- **page_count** (integer) - The number of pages for the results.
- **result_count_time** (string) - The time taken to count the results.
- **serialization_time** (string) - The time taken for serialization.

#### Response Example
```json
{
    "result": [
        {
            "id": "d46a2d3b90c94e368a70bc30acd30572",
            "type": "Project",
            "name": "Project #1",
            "tasks": [
                {
                "id": "4a6894302db74c94b989fcac7e68a38e",
                "name": "Task #1",
                "type": "Task"
                }
            ],
            "description": "This is the description of the first project.",
            "owner": null,
            "priority": 2
        },
        {
            "id": "6941a2af4c024b429ffc4851b404af72",
            "type": "Project",
            "name": "Project #2",
            "tasks": [],
            "description": "My second project.",
            "owner": null,
            "priority": 3
        },
        {
            "id": "8db88530ea5949ba89cef1234e04d8e4",
            "type": "Project",
            "name": "Project #3",
            "tasks": [],
            "description": "Third project description.",
            "owner": null,
            "priority": 1
        }
    ],
    "query_time": "0.000159363",
    "result_count": 3,
    "page_count": 1,
    "result_count_time": "0.000065976",
    "serialization_time": "0.004041883"
}
```
```

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

### Obtain Let's Encrypt Certificate via REST API

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Requests an SSL certificate from Let's Encrypt using the Structr REST API. This command specifies the server environment ('production' or 'staging'), the challenge type ('http' or 'dns'), and a wait time. Note that 'localhost' is not supported for certificate issuance.

```bash
curl -XPOST \
  -HX-User:admin \
  -HX-Password:admin \
  http://your-domain.com/structr/rest/maintenance/letsencrypt \
  -d '{"server":"production","challenge":"http","wait":"10"}'
```

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

### Test Local HTTPS with Curl

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

This snippet demonstrates how to test HTTP to HTTPS redirects and HTTPS connections locally using curl. It includes commands to check redirects and connect to the HTTPS port, ignoring certificate warnings for self-signed certificates.

```bash
# Test HTTP to HTTPS redirect
curl -I http://localhost:8082
# Should redirect to https://localhost:8443 (or configured HTTPS port)

# Test HTTPS connection (with self-signed cert)
curl -k -I https://localhost:8443
# -k flag ignores certificate warnings for self-signed certs

# Test admin interface
curl -k -I https://localhost:8443/structr/
```

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

### Configure Structr for Development Ports (No HTTPS)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

These are configuration settings for Structr, not executable code. They disable HTTPS and specify an HTTP port for development purposes, allowing access to the application without SSL.

```properties
# In Server Settings
application.http.port = 8082
application.https.enabled = false
```

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

### Update Structr and Monitor Security Advisories

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Commands and actions for maintaining Structr security. This includes updating the package list and upgrading Structr, subscribing to security mailing lists, and performing regular certificate health checks using an external tool.

```bash
# Keep Structr updated
sudo apt update && sudo apt upgrade structr

# Monitor security advisories
# Subscribe to Structr security mailing list

# Regular certificate health checks
curl -s https://crt.sh/?q=localhost
```

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

### Structr Log Example for Permission Denied

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/2-Core Concepts/5-Security.md

This is a sample log entry from Structr indicating a resource permission issue. It shows that a 'User' resource was found, but the 'GET' method was not allowed for public users. Analyzing such logs helps in diagnosing access control problems.

```log
INFO org.structr.web.auth.UiAuthenticator - Resource permission found for signature 'User', but method 'GET' not allowed for public users.
```

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

### Additional Security Settings for Let's Encrypt

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Configures advanced security and certificate renewal settings. This includes the renewal challenge type (e.g., 'http') and an administrative email address for notifications. Advanced SSL settings for protocols and cipher suites can also be defined here to enhance security.

```properties
# Certificate renewal settings
letsencrypt.challenge = http
letsencrypt.email = admin@yourdomain.com

# Advanced SSL settings
application.ssl.protocols = TLSv1.2,TLSv1.3
application.ssl.ciphers = ECDHE-RSA-AES256-GCM-SHA384,ECDHE-RSA-AES128-GCM-SHA256
```

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

### Structr Project JSON Object Example

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/1-Backend.md

An example of a JSON object representing a Structr Project. It includes basic project details, a nested array of Task objects, and other fields like owner and dates. This format is used for data transfer via the REST API.

```json
{
    "id": "a01e2889c25045bdae6b33b9fca49707",
    "name": "Project #1",
    "type": "Project",
    "description": "An example project",
    "priority": 2,
    "tasks": [
        {
            "id": "dfa33b9dcda6454a805bd7739aab32c9",
            "name": "Task #1",
            "type": "Task"
        },
        {
            "id": "68122629f8e6402a8b684f4e7681653c",
            "name": "Task #2",
            "type": "Task"
        }
    ],
    "owner": {},
    "other": null,
    "example": {
        "name": "A nested example object",
        "fields": []
    },
    "createdDate": "2020-04-21T18:31:52+0200"
}
```

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

### Configure Repeater for Project Data in Structr

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/2-First Steps.md

This snippet outlines the configuration steps within Structr to make a table dynamically display all 'Project' entities. It involves setting up a Function Query and a data key.

```structr-config
1. Select the table row (`tr`) element
2. Switch to the "Repeater" tab
3. Set up a Function Query: `find('Project')`
4. Set the data key to "project"
```

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

### Find with Starts With Predicate

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/5-API Reference/4-Function List.md

Creates a query predicate for finding entities where a specific key's value begins with a given substring. Useful for pattern matching at the start of strings.

```structr
find.starts_with(key, value)
```

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

### Configure GET Permissions for Projects in Structr

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/2-First Steps.md

This snippet explains how to grant authenticated users read access to 'Project' resources in Structr by configuring resource permissions.

```structr-ui
1. Switch to the "Resource Access" tab.
2. Create a permission for "Project" resources.
3. Enable "GET" for authenticated users.
```

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

### Configure POST Permissions for Projects/_id in Structr

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/2-First Steps.md

This snippet details how to enable authenticated users to create new projects in Structr by setting up POST permissions for 'Project/_id' resources.

```structr-ui
1. Create a permission for "Project/_id" resources.
2. Enable "POST" for authenticated users.
```

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

### Create User in Structr Security

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/2-First Steps.md

This section describes the process of creating a new user account within the Structr security configuration, including renaming the user and setting a secure password.

```structr-ui
1. Navigate to `Security` > `User` and click "Create".
2. Rename the user from "New User" to a desired name.
3. Right-click the user, select "General", and set a strong password.
```

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

### Find Index of Substring

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/5-API Reference/4-Function List.md

Returns the starting index of the first occurrence of a specified word within a given string. Returns -1 if the word is not found.

```structr
index_of(str, word)
```

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

### Create Group and Add User in Structr

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/2-First Steps.md

This snippet details the steps for creating a new user group and adding an existing user to that group in Structr's security settings.

```structr-ui
1. Navigate to `Security` > `Group` and click "Create".
2. Rename the group from "New Group" to a desired name.
3. Drag the user onto the group to add them as a member.
```

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

### Interact with Structr API via REST Console (Shell)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/2-Core Concepts/5-Security.md

This example shows how to use the Structr Admin Console in REST mode to interact with the API. It includes commands to set the mode to 'REST', perform a GET request for users, and authenticate as an administrator before performing another GET request. This is useful for testing endpoint access and permissions.

```shell
Mode set to 'REST'
anonymous@Structr> get /User
anonymous@Structr> auth admin admin
admin@Structr> get /User
```

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

### Check SSL Certificate Expiration

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Determines the expiration date of an SSL certificate for a given domain by connecting to the server and parsing the certificate details. It outputs the expiration date.

```bash
echo | openssl s_client -connect demoNN.structr.com:443 2>/dev/null | \
  openssl x509 -noout -dates
```

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

### Fetch All Projects (Bash/Curl)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/1-Backend.md

A command-line example using curl to fetch all Project objects from the REST API. It includes basic HTTP header authentication with the default admin user.

```bash
$ curl -s -HX-User:admin -HX-Password:admin http://localhost:8082/structr/rest/Project
```

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

### Dynamic Project Data in Structr Table

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/2-First Steps.md

This snippet shows how to populate table columns with dynamic project data using Structr's template expressions. It fetches the project name and a comma-separated list of milestone names.

```structr-template
Name column: ${project.name}
Description column: ${join(extract(project.milestones, "name"), ", ")}
```

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

### Create Projects via REST API (jQuery, fetch, curl)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/1-Backend.md

Demonstrates how to create new projects by sending a POST request with project data in JSON format. Supports multiple methods for API interaction.

```javascript
$.ajax({
    url: '/structr/rest/Project/info',
    method: 'POST',
    data: JSON.stringify([
        { "name": "New Project 2" },
        { "name": "Another project" },
        { "name": "Project X", "description": "A secret Project" }
    ]},
    statusCode: {
        201: function(result) {
            result.forEach(function(project) {
                // process result
            });
        }
    }
});
```

```bash
$ curl -s -HX-User:admin -HX-Password:admin http://localhost:8082/structr/rest/Project -XPOST -d '
    [
    { "name": "New Project 2" },
    { "name": "Another project" },
    { "name": "Project X", "description": "A secret Project" }
    ]'
```

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

### Generate Self-Signed Certificate for Localhost

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Generates a self-signed SSL certificate and private key for 'localhost' using OpenSSL. The certificate is valid for 365 days and is not encrypted with a passphrase. The generated files are then moved to the Structr SSL directory.

```bash
# Generate self-signed certificate for localhost
openssl req -x509 -newkey rsa:4096 -keyout localhost-key.pem -out localhost-cert.pem -days 365 -nodes -subj "/CN=localhost"

# Move certificates to Structr SSL directory
sudo mkdir -p /opt/structr/ssl/
sudo mv localhost-cert.pem /opt/structr/ssl/
sudo mv localhost-key.pem /opt/structr/ssl/
```

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

### Pseudo Graph Database Example (Project Query)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/2-Core Concepts/1-Database.md

Illustrates the potential outcome of querying a project by name in a 'pseudo graph database' where semantically identical entities might have different IDs, leading to multiple results.

```APIDOC
## GET /Project (Pseudo Graph Example)

### Description
This example demonstrates how querying a project by name in a pseudo graph database might return multiple project records, even if they share the same name but have different internal IDs. This contrasts with a true graph database where unique entities are represented by a single node.

### Method
GET

### Endpoint
`/Project`

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the project to query.

### Request Example
`GET /Project?name=X`

### Response
#### Success Response (200)
- **type** (string) - The type of the node (e.g., "Project").
- **id** (string) - The unique identifier of the node.
- **name** (string) - The name of the node.
- **projects** (array) - A list of associated projects (if the node type is "Project"). Each project object contains 'type', 'id', and 'name'.

#### Response Example
```json
[
    {
        "type": "Project",
        "id": "1",
        "name": "X",
        "projects": [
            {
                "type": "Project",
                "id": "3",
                "name": "A"
            }
        ]
    },
    {
        "type": "Project",
        "id": "2",
        "name": "X",
        "projects": [
            {
                "type": "Project",
                "id": "4",
                "name": "B"
            }
        ]
    }
]
```
```

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

### Create Project with Existing Task

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/1-Backend.md

Demonstrates how to create a new project and associate an existing task using its ID.

```APIDOC
## POST /structr/rest/Project

### Description
Creates a new project and optionally associates existing tasks with it.

### Method
POST

### Endpoint
/structr/rest/Project

### Parameters
#### Request Body
- **name** (string) - Required - The name of the project.
- **description** (string) - Optional - A description for the project.
- **priority** (integer) - Optional - The priority of the project.
- **tasks** (array) - Optional - An array of tasks to associate with the project. Each task can be represented by its ID or a more detailed object.
  - **id** (string) - Required (if task object is used) - The UUID of the task.
  - **name** (string) - Optional - The name of the task (for referencing).

### Request Example
```json
{
    "name": "Project #2",
    "description": "A second example project",
    "priority": 1,
    "tasks": [
        {
          "id": "dfa33b9dcda6454a805bd7739aab32c9"
        }
    ]
}
```

### Response
#### Success Response (200 or 201)
- **id** (string) - The unique identifier (UUID) of the created project.
- **type** (string) - The type of the object (e.g., "Project").
- **name** (string) - The name of the project.
- **description** (string) - The description of the project.
- **priority** (integer) - The priority of the project.
- **tasks** (array) - An array of associated task objects.

#### Response Example
```json
{
    "id": "some-new-project-uuid",
    "type": "Project",
    "name": "Project #2",
    "description": "A second example project",
    "priority": 1,
    "tasks": [
        {
            "id": "dfa33b9dcda6454a805bd7739aab32c9",
            "type": "Task",
            "name": "Task #1"
        }
    ]
}
```
```

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

### Create Project using curl

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/1-Backend.md

Demonstrates how to create a new project object using the curl command-line tool. It specifies the endpoint, HTTP method (POST), authentication headers, and provides the project data as a JSON payload in the request body.

```bash
$ curl -s -HX-User:admin -HX-Password:admin http://localhost:8082/structr/rest/Project -XPOST -d '{ "name": "New Project" }'
```

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

### Create Structr SSL Certificate Monitoring Script

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/7-HTTPS Setup.md

Creates a bash script to check the expiration date of the SSL certificate for 'localhost'. If the certificate expires within 30 days, it prints a warning message. The script is then made executable and added to the crontab for daily execution.

```bash
cat > /opt/structr/scripts/check-ssl.sh << 'EOF'
#!/bin/bash
DOMAIN="localhost"
EXPIRY=$(echo | openssl s_client -connect $DOMAIN:443 2>/dev/null |
         openssl x509 -noout -enddate | cut -d= -f2)
EXPIRY_DATE=$(date -d "$EXPIRY" +%s)
CURRENT_DATE=$(date +%s)
DAYS_UNTIL_EXPIRY=$(( (EXPIRY_DATE - CURRENT_DATE) / 86400 ))

if [ $DAYS_UNTIL_EXPIRY -lt 30 ]; then
    echo "WARNING: SSL certificate expires in $DAYS_UNTIL_EXPIRY days"
fi
EOF

chmod +x /opt/structr/scripts/check-ssl.sh

# Add to crontab for daily checking
echo "0 9 * * * /opt/structr/scripts/check-ssl.sh" | crontab -
```

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

### Create Project

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/1-Backend.md

This section details how to create new Project objects in Structr using POST requests. It covers creating single and multiple projects simultaneously.

```APIDOC
## POST /structr/rest/Project

### Description
Creates new objects of type 'Project' in the database. You can create a single project or multiple projects in a single transaction for efficiency and atomicity.

### Method
POST

### Endpoint
/structr/rest/Project

### Parameters
#### Request Body
- **(object | array)** - Required - A JSON object representing a single project to create, or an array of JSON objects for creating multiple projects.
  - **name** (string) - Required - The name of the project.
  - **description** (string) - Optional - A description for the project.
  - **priority** (integer) - Optional - The priority of the project.

### Request Example (Single Project)
```javascript
// Using fetch API
fetch('/structr/rest/Project/info', {
    method: 'POST',
    credentials: 'include',
    body: JSON.stringify({
        name: "New Project"
    }),
}).then(function(response) {
    return response.json();
}).then(function(json) {
    console.log(json.result);
});
```

### Request Example (Multiple Projects)
```javascript
// Using fetch API
fetch('/structr/rest/Project/info', {
    method: 'POST',
    credentials: 'include',
    body: JSON.stringify([
        { "name": "New Project 2" },
        { "name": "Another project" },
        { "name": "Project X", "description": "A secret Project" }
    ]),
}).then(function(response) {
    return response.json();
}).then(function(json) {
    json.result.forEach(newProjectId => {
        console.log('Created project ID:', newProjectId);
    });
});
```

### Response
#### Success Response (201)
- **result** (array) - An array containing the UUIDs of the newly created project(s).
- **result_count** (integer) - The number of objects created.
- **page_count** (integer) - The number of pages for the results.
- **result_count_time** (string) - The time taken to count the results.
- **serialization_time** (string) - The time taken for serialization.

#### Response Example
```json
{
    "result": [
        "b0f7e79a17c649a9934687554990acd5"
    ],
    "result_count": 1,
    "page_count": 1,
    "result_count_time": "0.000048183",
    "serialization_time": "0.000224176"
}
```
```

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

### GET HTTP Request

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/5-API Reference/4-Function List.md

Sends an HTTP GET request to the given URL and returns the response headers and body. This method can be used in a script to make an HTTP GET request from within the Structr Server, triggered by a frontend control like a button etc.

```APIDOC
## GET /structr/structr

### Description
Sends an HTTP GET request to the given URL and returns the response headers and body. This method can be used in a script to make an HTTP GET request from within the Structr Server, triggered by a frontend control like a button etc.

The `GET()` method will return a response object with the following structure:

- **status** (Integer) - HTTP status of the request
- **headers** (Map) - Response headers
- **body** (Map or String) - Response body

### Method
GET

### Endpoint
/structr/structr

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
${GET('http://localhost:8082/structr/rest/User')}
```

### Response
#### Success Response (200)
- **status** (Integer) - HTTP status of the request
- **headers** (Map) - Response headers
- **body** (Map or String) - Response body

#### Response Example
```json
{
  "status": 200,
  "headers": {},
  "body": {}
}
```

### Notes
- From version 3.5 onwards, GET() supports binary content by setting the `contentType` parameter to `application/octet-stream`.
- v4.0+: `contentType` can be used like the `Content-Type` header - to set the **expected** response mime type and to set the `charset` with which the response will be interpreted.
- Prior to v4.0: `contentType` is the **expected** response content type.
- The parameters `username` and `password` are intended for HTTP Basic Auth. For header authentication use `add_header()`.
- The `GET()` method will **not** be executed in the security context of the current user. The request will be made **by the Structr server**, without any user authentication or additional information.
- As of Structr 6.0, it is possible to restrict HTTP calls based on a whitelist setting in structr.conf, `application.httphelper.urlwhitelist`. However the default behaviour in Structr is to allow all outgoing calls.
```

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

### Configure CORS Settings in Structr

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/1-Introduction/2-First Steps.md

This snippet lists the configuration parameters for enabling cross-origin requests in Structr, specifying the request URI and various CORS headers.

```structr-config
1. Switch to "CORS Settings".
2. Set request URI to `/structr/html/projects`.
3. Configure CORS headers:
   - Accepted Origins: `*`
   - Max Age: `3600`
   - Allow Methods: `HEAD, GET, PUT, POST, OPTIONS`
   - Allow Headers: `Content-Type, Accept`
   - Allow Credentials: `true`
   - Expose Headers: `Allow`
```

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

### Send HTTP GET Request from Structr Server

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/5-API Reference/4-Function List.md

The GET() function performs an HTTP GET request to a given URL, returning response headers and body. It operates from the Structr server's context and supports various signatures for content types, authentication (basic auth via username/password or header auth via add_header()), and content selection. Binary content and charset interpretation are also supported.

```javascript
GET(GET(url [, contentType [, username, password]]))
```

```javascript
GET(GET(url, 'text/html', selector))
```

```javascript
GET(GET(url, 'application/octet-stream' [, username, password]))
```

```javascript
${GET('http://localhost:8082/structr/rest/User')}
```

```javascript
${(
	  add_header('X-User', 'admin'),
	  add_header('X-Password', 'admin'),
	  GET('http://localhost:8082/structr/rest/User')
	)}
```

```javascript
${GET('http://www.google.com', 'text/html')}
```

```javascript
${GET('http://www.google.com', 'text/html; charset=UTF-8')}
```

```javascript
${GET('http://www.google.com', 'text/html; charset=ISO-8859-1')}
```

```javascript
${GET('http://www.google.com', 'text/html', '#footer')}
```

```javascript
${set_content(create('File', 'name', 'google_logo.png'), GET('https://www.google.com/images/branding/googlelogo/1x/googlelogo_light_color_272x92dp.png', 'application/octet-stream'))}
```

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

### Configure OAuth Provider (Auth0)

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/3-Advanced Topics/6-Authentication.md

Example configuration for the Auth0 OAuth provider in `structr.conf`. This requires client ID, secret, authorization and token endpoints, redirect URI, and user details endpoints from Auth0. It also specifies error and return URIs for the application.

```properties
oauth.auth0.client_id = YOUR_CLIENT_ID

```

```properties
oauth.auth0.client_secret = YOUR_CLIENT_SECRET

```

```properties
oauth.auth0.authorization_location = https://YOUR_AUTH0_DOMAIN/authorize

```

```properties
oauth.auth0.token_location = https://YOUR_AUTH0_DOMAIN/oauth/token

```

```properties
oauth.auth0.redirect_uri = http://localhost:8082/oauth/auth0/callback

```

```properties
oauth.auth0.user_details_resource_uri = https://YOUR_AUTH0_DOMAIN/userinfo

```

```properties
oauth.auth0.error_uri = /error

```

```properties
oauth.auth0.return_uri = /

```

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

### Get String Length

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/5-API Reference/4-Function List.md

Calculates and returns the length (number of characters) of a given string.

```structr
length(str)
```

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

### Get Element by Index

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/5-API Reference/4-Function List.md

Retrieves an element from a list or collection at a specified index. Indexes are zero-based.

```structr
nth(list, index)
```

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

### Structr 'host' Keyword Example

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/5-API Reference/1-Keywords.md

Demonstrates how to retrieve the host name of the server from the request using the 'host' keyword. This is useful for dynamic URL generation or logging.

```structrscript
${host}
```

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

### Neo4j Bolt Driver Configuration

Source: https://context7.com/structr/structr/llms.txt

Configure the Neo4j Bolt connection settings and connection pool for production deployments. This section also provides an example of programmatic access to the database service for creating nodes within a transaction.

```APIDOC
## Neo4j Bolt Driver Configuration

### Description
Configure the Neo4j Bolt connection settings and connection pool for production deployments. This section also provides an example of programmatic access to the database service for creating nodes within a transaction.

### Method
N/A (Configuration)

### Endpoint
N/A (Configuration)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```java
// Configuration in structr.conf or as environment variables

// Neo4j Bolt connection settings
database.driver = org.structr.bolt.BoltDatabaseService
database.connection.url = bolt://localhost:7687
database.connection.username = neo4j
database.connection.password = your-password

// Connection pool settings
database.connection.pool.max = 50
database.connection.pool.idle = 10
database.connection.pool.timeout = 30

// Transaction settings
database.transaction.timeout = 30000

// Programmatic access to database service
import org.structr.api.DatabaseService;
import org.structr.core.Services;
import org.structr.api.Transaction;

DatabaseService dbService = Services.getInstance().getDatabaseService();

try (Transaction tx = dbService.beginTx()) {
    // Execute native database operations
    org.structr.api.graph.Node nativeNode = dbService.createNode(
        Set.of("User"),
        Map.of("name", "John", "email", "john@example.com")
    );

    System.out.println("Created node with ID: " + nativeNode.getId());
    tx.success();
}
```

### Response
#### Success Response (200)
N/A (Configuration)

#### Response Example
N/A (Configuration)
```

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

### get

Source: https://github.com/structr/structr/blob/main/structr-app/src/main/resources/structr/docs/5-API Reference/4-Function List.md

Retrieves the value of a specified property from an entity. Returns an empty string if the property does not exist.

```APIDOC
## get

### Description
Returns the value with the given name of the given entity, or an empty string.

### Method
N/A (This appears to be a function call within the Structr scripting language, not a standard HTTP API endpoint).

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
get(userEntity, 'name')
```

### Response
#### Success Response (200)
- **value** (string) - The value of the property.

#### Response Example
```json
"John Doe"
```
```
Tokens:
Raw