Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Contact Social Media Macroscope development team to acquire current SMILE credentials Chen Wang
  • Alternatively, you can set up your own set of credentials by configuring the below shell script.


Shell script:Using Traefik

Code Block
languagebash
# system setting
export DOCKERIZED=true

# if use AWS algorithm, then you must use a static IP address
export LOCAL_ALGORITHM=true
export HOST_IP=<your host IP address>
export HOME=<your path on host machine>
export BUCKET_NAME=macroscope-smile
#set server info
export SERVER=smm.server.com
# single user version vs multiple users 
export SINGLE_USER=true

# create mounted volumes on host machine
mkdir -p ${HOME}/smile_data
mkdir -p ${HOME}/smile_data/${BUCKET_NAME}
mkdir -p ${HOME}/smile_user
mkdir -p ${HOME}/smile_tag

# email notification (To enable notification, uncomment below and put down valid email server information) 
# export EMAIL_HOST=
# export EMAIL_PORT=
# export EMAIL_FROM_ADDRESS=
# export EMAIL_PASSWORD=

# CiLogon
export CILOGON_CLIENT_ID=
export CILOGON_CLIENT_SECRET=
export CILOGON_CALLBACK_URL=
# put down your own RANDOM keys at least 8 digits;
# if wish to align with your AWS deployment, please put down AWS access key and secret (Not required if LOCAL_ALGORITHM=true) 
export AWS_ACCESSKEY=AAAAAAAAAAAAAAAAAAAAA
export AWS_ACCESSKEYSECRET=BBBBBBBBBBBBBBBBBBBBBBBBBB

# social media platforms
export REDDIT_CLIENT_ID=
export REDDIT_CLIENT_SECRET=
export TWITTER_CONSUMER_KEY=
export TWITTER_CONSUMER_SECRET=

# export
export BOX_CLIENT_ID=
export BOX_CLIENT_SECRET=
export DROPBOX_CLIENT_ID=
export DROPBOX_CLIENT_SECRET=
export GOOGLE_CLIENT_ID=
export GOOGLE_CLIENT_SECRET=

# start
docker-compose -f docker-compose-smile.yml up

# stop
# docker-compose -f docker-compose-smile.yml down -v

Variables Explained

  • System setting. Set to true to use standalone containerized SMILE.
    • DOCKERIZED=true
  • If using algorithm deployed on AWS, then you must use a static IP address.
    • LOCAL_ALGORITHM=true
  • Single user mode vs multiple users mode.
    • SINGLE_USER=false
  • Settings for CILOGON (this section is not required if running in single user mode)
    • CILOGON_CLIENT_ID={{cilogon id}}
    • CILOGON_CLIENT_SECRET={{cilogon client secret}}
    • CILOGON_CALLBACK_URL={{ci logon callback url}}
  • Configure email server to enable capability of sending email notifications for long running jobs.
    • EMAIL_HOST={{email host}}
    • EMAIL_PORT=465
    • EMAIL_FROM_ADDRESS={{email from address}}
    • EMAIL_PASSWORD={{email password}}
  • MINIO access keys and secret. Can be set to align with AWS S3 access keys and secret.
    • AWS_ACCESSKEY={{aws_accesskey}}
    • AWS_ACCESSKEYSECRET={{aws_accesskeysecret}}
  • Social media platforms configurations.
    • REDDIT_CLIENT_ID={{reddit client id}}
    • REDDIT_CLIENT_SECRET={{reddit client secret}}
    • REDDIT_CALLBACK_URL={{reddit callback url}}
    • TWITTER_CONSUMER_KEY={{twitter consumer key}}
    • TWITTER_CONSUMER_SECRET={{twitter consumer secret}}
    • TWITTER_V2_CLIENT_ID={{twitter v2 client id}}
    • TWITTER_V2_CLIENT_SECRET={{twitter v2 client secret}}
    • TWITTER_V2_CALLBACK_URL={{twitter v2 callback url}}
  • Cloud storage platforms configurations (Optional)
    • BOX_CLIENT_ID=
    • BOX_CLIENT_SECRET={{box client secret}}
    • DROPBOX_CLIENT_ID={{dropbox client id}}
    • DROPBOX_CLIENT_SECRET={{dropbox client secret}}
    • GOOGLE_CLIENT_ID={{google client id}}
    • GOOGLE_CLIENT_SECRET={{google client secret}}
  • Clowder configurations (Optional)
    • CLOWDER_BASE_URL={{clowder instance base url}}
    • CLOWDER_GLOBAL_KEY={{clowder global key}}
    • CLOWDER_ON=false (enable connection to clowder or not)

Note:

  • You need to place your host IP address to HOST_IP variable. For example, mine IP is 192.168.10.12. If you are a mac user, you can find your IP here

...