Ontopic Docs

# Local Materialization

# Ontopic Studio Desktop

Starting from Ontopic Studio 2024.1.3

Materialization to RDF is enabled by default.

# Locally stored files

Files are stored locally in the %AppData% folder.
You can open the folder containing the materialized files from the materialization file list. \

# Notes

Please ensure that there is sufficient space available to avoid potential storage issues and check if your environment backs up this directory to cloud storage.

# How to access the materialization folder of Ontopic Studio

The AppData folder contains all stored data that should be kept even in case of update or temporary uninstall of the application.
To access the AppData folder press Windows + R buttons to open the Run App.
In the run app text box, enter %AppData% and click OK. Windows will directly open up the Roaming folder.
You can now access the OntopicStudio folder and select materialization-result.

# Docker-compose

Starting from Ontopic Studio 2024.1.0

WARNING

Not recommended for production environments

This Docker-compose approach for local materialization should only be used for development or testing purposes. For production environments, we strongly recommend using S3-based materialization which provides better performance, backups and data management. See our S3 materialization guide for details.

You can enable materialization using the dedicated script.

# Run the script

./enable-materialization.sh

Answer y to enable the materialization.
When prompted for S3 parameters, simply press Enter without entering any values to enable local materialization only.

The environment variables will be updated as explained in the next paragraphs.

# Secrets and Configuration Paths

  • It sets the secrets_folder to ./default-secrets or to the legacy folder ./secrets if the latter exists.
  • The following variables are initialized:
    • CONFIG_FILE: Path to the configuration file (./.env by default).
    • SECRETS_DIR: Root directory for secrets (default: ./secrets).
    • VOLUMES_DIR: Root directory for volumes (default: ./volumes).

# Materialization Prompt

  • Asks the user whether to enable materialization.
  • If the answer is "yes" (y), it sets ENABLE_MATERIALIZATION to true.
  • Otherwise, it sets it to false and exits the script.

# S3 Configuration

  • Enters the S3 section.
  • Prompts the user for the S3 access key ID and secret.
  • Files are not updated if no value is provided.

# S3 Bucket and Region

  • Prompts the user for the S3 bucket name and region.
  • Writes empty configurations in the .env file if no value is provided.

# Materialization Result and Configuration Directories

  • Sets the paths for materialization result and configuration directories in the default volumes directory.
  • Prints these paths.

The script sets the following environment variables:

  • ENABLE_MATERIALIZATION: Whether materialization is enabled.
  • S3_BUCKET: The S3 bucket name. (empty for local materialization)
  • S3_REGION: The S3 region. (empty for local materialization)
  • MATERIALIZATION_RESULT_DIR: The directory for materialization results.
  • MATERIALIZATION_CONFIGURATION_DIR: The directory for materialization configuration.

# Locally stored files

Files are stored locally in the ./volumes/materialization-result folder.
You can also export the materialized files from the materialization file list.

# Notes

Please ensure that there is sufficient space available to avoid potential storage issues. All values are saved by default in the ./volumes folder.

← Setting up HTTPS →