hub-store Configuration#
Configuration#
The following environment variables can be used to configure hub-store. An up-to-date version with more information regarding the deployment can be found in the gitlab repository..
A deployment guide can be found in the Guide section of this documentation.
| Key | Description | Default | Type |
|---|---|---|---|
| MONGO_DB_URI | The URL for the mongodb used by this service | "mongodb://localhost:27017" |
string |
| MONGO_DB_NAME | The name for the database the files will be stored in | "piveau" |
string |
| MONGO_DB_COLLECTION | The name for the database the files will be stored in | "data" |
string |
| MONGO_USER | The User for the database | string |
|
| MONGO_PW | The password for the database | string |
|
| HTTP_PORT | Port used to communicate with the API | 8080 |
int |
| PIVEAU_STORE_AUTH_CONFIG | For fetching public keys and authentication. E.G. {"tokenServerConfig":{"keycloak":{"realm":"piveau","serverUrl":"https://auth.domain.tld/auth"}}} | object |
|
| PIVEAU_STORE_CORS_DOMAINS | Setting allowed CORS domains | ["*"] |
array |
| STORAGE_BACKEND | S3 or FILE, to specify the storage backend to be used |
"FILE" |
enum |
| STORAGE_DEFAULT_DIRECTORY | The base directory to save the files. Only used with STORAGE_BACKEND != S3 |
"data-store" |
string |
| STORAGE_DEFAULT_BUCKET | The S3 bucket to save the files. Only used with STORAGE_BACKEND = S3 |
"data-store" |
string |
| S3_ENDPOINT | if STORAGE_BACKEND is S3, this will be used to set the S3 endpoint |
string |
|
| S3_ACCESSKEY | if STORAGE_BACKEND is S3, this will be used to set the S3 access key/username |
string |
|
| S3_SECRET | if STORAGE_BACKEND is S3, this will be used to set the S3 secret key/password |
string |
|
| S3_REGION | if STORAGE_BACKEND is S3, this will be used to set the S3 region, e.g. eu-central-1 |
string |
|
| CLAMAV_ENABLED | indicates if the virus scanning funtionality should be enabled | false |
boolean |
| CLAMAV_HOST | the host part of the address to the clam AV daemon | "localhost" |
string |
| CLAMAV_PORT | the port part of the address to the clam AV daemon | 3310 |
int |
| ALLOWED_MIME_TYPES | This 'ALLOWED_MIME_TYPES' will be used to restrict the content type of file | "ALLOWED_MIME_TYPES" |
array |
Logging:
| Variable | Description | Default Value |
|---|---|---|
PIVEAU_HUB_STORE_LOG_APPENDER |
Configures the log appender for the pipe context | STDOUT |
LOGSTASH_HOST |
The host of the logstash service | logstash |
LOGSTASH_PORT |
The port the logstash service is running | 5044 |
PIVEAU_HUB_STORE_LOG_LEVEL |
The log level for the service console. | INFO |