contributor: Yong Wook Kim 

Necessary Variables

namedescription notes
SERVERdomain name of the siteThis should be the main domain id like without http or https prefix.
HOMEpath for home directoryThis 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_NAMEbucket name that is used for saving the data in minioThe 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_URLURL for the smile's graphql serverIt is the combination of main url with port, like http://${SERVER}:5050/graphql
CILOGON_CLIENT_IDclient id for cilogon
CILOGON_CLIENT_SECRETclient secret for cilogon
CILOGON_CALLBACK_URLcall back url for cilogon
RABBITMQ_URLurl of rabbitmqThe default values is amqp://${SERVER}:5672
RABBITMQ_HOSThost of the rabbitmqThis is usually the same as SERVER information, so it can be just ${server}
REDIS_URLurl for the redisThe default is usually redis://redis:6379 and this might not need to be changed
AWS_ACCESSKEYaccess key values for awsThis 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_ACCESSKEYSECRETaccess secret for awsThis also should not be empty because it is being used as minio password

Optional Variables

REDDIT_ONvariable to select whether to use reddit or notThe value should be either true or false.
REDDIT_CLIENT_IDreddit client id
REDDIT_CLIENT_SECRETreddit client secret
REDDIT_CALLBACK_URLreddit callback url
TWITTER_ONvariable to select whether to use twitter or notThe value should be either true or false.
TWITTER_CONSUMER_KEYconsumer key for twitter api version 1This is not being used any more due to the termination of the service.
TWITTER_CONSUMER_SECRETconsumer secret for twitter api version 1This is not being used any more due to the termination of the service.
TWITTER_V2_CLIENT_IDclient id for X (twitter api version 2)
TWITTER_V2_CLIENT_SECRETclient secret for X (twitter api version 2)
TWITTER_V2_CALLBACK_URLcall back url for X (twitter api version 2)
BOX_CLIENT_IDclient id for Box service
BOX_CLIENT_SECRETclient secret for Box service
DROPBOX_CLIENT_IDclient id for dropbox service
DROPBOX_CLIENT_SECRETclient secret for dropbox secret
GOOGLE_CLIENT_IDclient id for google
GOOGLE_CLIENT_SECRETclient secret for google
CLOWDER_ONvariable to select whether to use clowder or notThe values should be either true or false
CLOWDER_BASE_URLbase url for the clowder serviceThe default is like https://clowder.${server}
CLOWDER_GLOBAL_KEYglobal key for the clowder

  • No labels