TODO: How This section describes how to and what to edit in the values.yaml
Secret Key
Specify the secret key of the application here. This should be a random string (min 30 characters), which needs to be kept confidential.
Scope: global
| Code Block | ||
|---|---|---|
| ||
# secretKey -- The application's secret key (can be left empty if SECRET_KEY is injected later)
secretKey: "" |
Domain
The application’s public domain/hostname
| Code Block | ||
|---|---|---|
| ||
# domain -- The application's public domain/hostname
domain: "" |
Database
It is required to configure an external database. The first section of the settings file is dedicated to the Database connection settings. Below you'll find a description of all possible parameters.
| Code Block | ||||
|---|---|---|---|---|
| ||||
dbConfig:
internal:
# dbConfig.internal.enabled -- set to true to use a postgresql instance deployed with this helm chart
enabled: true
external:
# dbConfig.external.enabled -- set to true to use an external database with the application
enabled: false
# dbConfig.external.useExistingConfigMap -- If the database configuration is created externally (e.g. through terraform) as a ConfigMap `db-config`, set this to true. In this case, all other settings in dbConfig.external are ignored
useExistingConfigMap: false
# dbConfig.external.engine -- Set to `psql` to use a postgresql database. set to `mysql` to use a mysql database
engine: psql
# dbConfig.external.host -- hostname/ip of the database
host:
# dbConfig.external.name -- database name to connect to
name:
# dbConfig.external.user -- username for the database connection
user:
# dbConfig.external.password -- password for the database connection
password:
# dbConfig.external.port -- Port of the datbase
port: 5432
ssl: false
# dbConfig.external.schema -- Postgresql schema to use, only relevant when dbConfig.external.engine: psql is set
schema: public
|
...
Settings Key
...
Possible Values
...
Description
...
internal
...
true or false
...
Set this to true to use an internal PostgreSQL DB instance deployed with this helm chart
...
external
...
true or false
...
Set this to true to use External Database
note: set
...
engine
...
psql or mysql
...
Set to psql to use PostgreSQL Dabatase or mysql for MySQL/MariaDB
...
host
...
IP or hostname
...
The host, under which the database server is reachable
...
name
...
Any String
...
The name of the database
...
user
...
Any String
...
The database user
...
password
...
Any String
...
The database users password
...
port
...
Numerical Port
...
The port where the database server listens for connections
...
ssl
...
true or false
...
Only for mysql: If an SSL secured database connection should be used.
...
schema
...
Any String
...
The name of the database schema to be used (just for psql, default is public)
Storage
The following section focuses on the configuration of the storage engines for the 3YOURMIND application.
File Storage Overview
A user of the application is able to upload a variety of different files to the platform. From the apps administrators perspective, there are 3 different types of files that can be uploaded:
Media files,
Private media files (Static files), and
3D files
Media files are usually provided by the service administrators and application administrators. These can be the logos of the 3D-Printing services, the background image of the 3D-viewer or additional documentation for the materials. These files are always public, as they either contribute to the themeing of the application or contain information that should be accessible by all users.
Private media files (static files) are files, that are uploaded by regular users of the application and only meant for the eyes of the user and printing service administrators. These include attachments to 3D projects. They are only accessible after logging in to the application and only if the user requesting them has sufficient rights on the file.
3D files are files, that are uploaded to the application for analysis, repair and quoting. These are also meant to be private. Only the printing service admins and the user who uploaded them should be able to see it.
The application currently supports two different storage engines for all uploaded files:
Local storage
AWS S3
Local Storage
The Local Storage engine stores the files in a folder of the servers file systems. This means that you can for example mount a remote drive via nfs and store all user uploads there. The uploaded files are then served from the server itself.
To enable the local storage for all files, find and set the following values in your app-config:
EMail Settings
Image registry
...
to tailor the configuration of your deployment.
Domain or hostname configuration