contributor: Yong Wook Kim
Necessary Variables
name | description | notes |
---|---|---|
SERVER | domain name of the site | This should be the main domain id like your.domain.name without http or https prefix. |
HOME | path for home directory | This is an optional when only for using docker-compose. The buckets and other data will be saved under this home directory |
MINIO_URL | the ip address or url for minio (internal or external) | This should be the similar to MINIO_PUBLIC_ACCESS_URL. However, in kubernetes, there are the minio url that is being used in kubernetes internal network, and the external minio url also needed to created the link for the minio access. |
MINIO_PUBLIC_ACCESS_URL | the ip address or url for minio (external) | This is the external access url for minio that is used to access minio for accessing the images in minio or downloading the data from minio. In case of kubernetes, MINIO_URL and MINIO_PUBLIC_ACCESS_URL might be different, but if it is docker compose, they would be identical. |
BUCKET_NAME | bucket name that is used for saving the data in minio | The default will be macroscope-smile. All the user data will be created in the bucket. |
RABBITMQ_HOST | the ip address or url for rabbitmg (internal or external) | Similar concept to minio url. This is the url for rabbitmq that might be used in kubernetes internal network. Kubernetes' components will try to access rabbitmq by using this url inside the kubernetes network. |
RABBITMQ_URL | the ip address or url for rabbitmq (externa) | RabbitMQ's external url that can be accessed outside the kubernetes network. You can access rabbitmq control panel using the browser using this URL. |
SMILE_GRAPHQL_URL | URL for the smile's graphql server | It is the combination of main url with port, like http://${SERVER}:5050/graphql |
CILOGON_CLIENT_ID | client id for cilogon | |
CILOGON_CLIENT_SECRET | client secret for cilogon | |
CILOGON_CALLBACK_URL | call back url for cilogon | |
RABBITMQ_URL | url of rabbitmq | The default values is amqp://${SERVER}:5672 |
RABBITMQ_HOST | host of the rabbitmq | This is usually the same as SERVER information, so it can be just ${server} |
REDIS_URL | url for the redis | The default is usually redis://redis:6379 and this might not need to be changed |
AWS_ACCESSKEY | access key values for aws | This is currently used as the login id for minio. Even though if it is not using the aws, this value should not be empty for minio use |
AWS_ACCESSKEYSECRET | access secret for aws | This also should not be empty because it is being used as minio password |
Optional Variables
name | description | notes |
---|---|---|
REDDIT_ON | variable to select whether to use reddit or not | The value should be either true or false. |
REDDIT_CLIENT_ID | reddit client id | |
REDDIT_CLIENT_SECRET | reddit client secret | |
REDDIT_CALLBACK_URL | reddit callback url | |
TWITTER_ON | variable to select whether to use twitter or not | The value should be either true or false. |
TWITTER_CONSUMER_KEY | consumer key for twitter api version 1 | This is not being used any more due to the termination of the service. |
TWITTER_CONSUMER_SECRET | consumer secret for twitter api version 1 | This is not being used any more due to the termination of the service. |
TWITTER_V2_CLIENT_ID | client id for X (twitter api version 2) | |
TWITTER_V2_CLIENT_SECRET | client secret for X (twitter api version 2) | |
TWITTER_V2_CALLBACK_URL | call back url for X (twitter api version 2) | |
BOX_CLIENT_ID | client id for Box service | |
BOX_CLIENT_SECRET | client secret for Box service | |
DROPBOX_CLIENT_ID | client id for dropbox service | |
DROPBOX_CLIENT_SECRET | client secret for dropbox secret | |
GOOGLE_CLIENT_ID | client id for google | |
GOOGLE_CLIENT_SECRET | client secret for google | |
CLOWDER_ON | variable to select whether to use clowder or not | The values should be either true or false |
CLOWDER_BASE_URL | base url for the clowder service | The default is like https://clowder.${server} |
CLOWDER_GLOBAL_KEY | global key for the clowder |