Merge branch 'master' of github.com:appsembler/tahoe

docs/development_environment_setup.md

@@ -25,16 +25,26 @@ curl -L https://raw.githubusercontent.com/appsembler/configuration/appsembler/fi
 ```
 
 https://github.com/appsembler/configuration/blob/appsembler/ficus/master/vagrant/release/devstack/Vagrantfile.amc
+
 4. Install the Vagrant vbguest plugin.
 ```
 vagrant plugin install vagrant-vbguest
 ```
-5. Create the Devstack virtual machine.
+5. Create the server vars file for the Ansible provisioning
+```
+mkdir devstack/src
+vi devstack/src/server-vars.yml
+```
+and copy the content of the [example server-vars.yml file](server-vars.yml.md).
+The piece that you need to fill out, it's the `EDXAPP_GIT_IDENTITY` that is used to clone and checkout the [edx-theme-codebase](https://github.com/appsembler/edx-theme-codebase) repository.
+Here is the documentation to generate a new deploy key and add it to github: [https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys)
+
+6. Create the Devstack virtual machine.
 ```
 vagrant up
 ```
 The first time you create the Devstack virtual machine, Vagrant downloads the base box, which has a file size of about 4GB. If you destroy and recreate the virtual machine, Vagrant re-uses the box it downloaded. See Vagrant’s documentation on boxes for more information.
-6. When prompted, enter the administrator password for your local computer.
+7. When prompted, enter the administrator password for your local computer.
 
 ### Run LMS and Studio
 In order to start the LMS and Studio development servers you need to run the following commands.

docs/example-files/server-vars.yml.md

@@ -0,0 +1,103 @@
+---
+
+edx_platform_repo: "https://github.com/appsembler/edx-platform.git"
+edx_ansible_source_repo: "https://github.com/appsembler/configuration"
+
+EDX_VERSION: "open-release/ficus.master"
+edx_platform_version: "appsembler/amc/develop"
+configuration_version: "appsembler/ficus/master"
+certs_version: "{{ EDX_VERSION | default('open-release/ficus.master') }}"
+forum_source_repo: "https://github.com/appsembler/cs_comments_service.git"
+forum_version: "{{ EDX_VERSION | default('open-release/ficus.master') }}"
+xqueue_version: "{{ EDX_VERSION | default('open-release/ficus.master') }}"
+NOTIFIER_VERSION: "{{ EDX_VERSION | default('open-release/ficus.master') }}"
+
+EDXAPP_DEFAULT_COURSE_MODE_SLUG: "honor"
+
+EDXAPP_APPSEMBLER_FEATURES:
+  TMP: 'none'
+
+EDXAPP_ENABLE_AUTO_AUTH: true
+
+EDXAPP_USE_GIT_IDENTITY: true
+EDXAPP_GIT_IDENTITY: |
+  -----BEGIN RSA PRIVATE KEY-----
+  MIIEowIBAAKCAQEA4pNFyN1gFjQ9RHfgWbJWzaHpYzM9WWtwAuYkSCAWAAsF0aT0
+  ...
+  cVXIa84zodEBu9Jaq2jWolV/4eNMpr7KHvA1Lhu/RGahFuyCGLpq7WOZzqp+dNi4
+  Sg06X+bPZckGSyllFNbuGPamljRAmoBtb7pk9Y4AcDkLkE5AoR+O
+  -----END RSA PRIVATE KEY-----
+
+EDXAPP_FEATURES:
+  ENABLE_SERVICE_STATUS: True
+  ENVIRONMENT: "{{ COMMON_ENVIRONMENT }}"
+  AUTH_USE_OPENID_PROVIDER: true  # default: true
+  ENABLE_OAUTH2_PROVIDER: true  # default: false
+  ALLOW_ALL_ADVANCED_COMPONENTS: true  # default: false
+  ENABLE_LTI_PROVIDER: true  # default: false
+  ENABLE_SYSADMIN_DASHBOARD: True  # default: false
+  CERTIFICATES_ENABLED: true  # default: true  <- check
+  CERTIFICATES_HTML_VIEW: true
+  ENABLE_DISCUSSION_SERVICE: true  # default: true
+  ENABLE_DISCUSSION_HOME_PANEL: true
+  ENABLE_INSTRUCTOR_ANALYTICS: true  # default: false
+  PREVIEW_LMS_BASE: "{{ EDXAPP_PREVIEW_LMS_BASE }}"
+  ENABLE_S3_GRADE_DOWNLOADS: true  # default: true
+  USE_CUSTOM_THEME: "{{ edxapp_use_custom_theme }}"
+  ENABLE_MKTG_SITE: "{{ EDXAPP_ENABLE_MKTG_SITE }}"  # default: false
+  AUTOMATIC_AUTH_FOR_TESTING: "{{ EDXAPP_ENABLE_AUTO_AUTH }}"  # default: false
+  ENABLE_THIRD_PARTY_AUTH: true
+  #search features in CMS
+  ENABLE_COURSEWARE_INDEX: true  # default: false
+  ENABLE_LIBRARY_INDEX: true  # default: false
+  #search features in LMS
+  ENABLE_COURSEWARE_SEARCH: true  # default: false
+  ENABLE_DASHBOARD_SEARCH: true  # default: false
+  ENABLE_COURSE_DISCOVERY: true # default: false
+  ENABLE_COMBINED_LOGIN_REGISTRATION: true  # default: false
+  ALLOW_HIDING_DISCUSSION_TAB: true
+  #for prereqs
+  MILESTONES_APP: true
+  ENTRANCE_EXAMS: true
+  ENABLE_SPECIAL_EXAMS: true
+  ENABLE_PREREQUISITE_COURSES: true
+  CUSTOM_COURSES_EDX: true
+  #for bulk email
+  ENABLE_INSTRUCTOR_EMAIL: true
+  REQUIRE_COURSE_EMAIL_AUTH: true
+  ENABLE_MOBILE_REST_API: true
+  ORGANIZATIONS_APP: true
+  # to avoid non staff user creating courses in studio
+  ENABLE_CREATOR_GROUP: true
+  LICENSING: true
+  # needed temporarily
+  AMC_APP_URL: "https://staging-amc-app.appsembler.com"
+  ENABLE_TIERS_APP: true
+
+EDXAPP_EXTRA_REQUIREMENTS:
+  - name: "git+https://github.com/pmitros/FeedbackXBlock.git#egg=feedback-xblock"
+  - name: "git+https://github.com/appsembler/[email protected]#egg=xblock-launchcontainer"
+  - name: 'git+https://github.com/MarCnu/pdfXBlock.git#egg=pdf'
+
+EDXAPP_AUTH_EXTRA:
+  TIERS_DATABASE_URL: "postgres://amc:@192.168.1.42:5432/amc"
+
+## Stanford theme
+edxapp_use_custom_theme: false # false to disable & use std. theme
+edxapp_theme_name: ""
+edxapp_theme_source_repo: "[email protected]:appsembler/edx-theme-codebase.git"
+edxapp_theme_version: "ficus/master" #branch
+edxapp_customer_theme_source_repo: "https://github.com/appsembler/edx-theme-customers.git"
+edxapp_customer_theme_version: "ficus/amc"
+
+# Comprehensive theme
+EDXAPP_COMPREHENSIVE_THEME_DIR: "{{edxapp_theme_dir}}"
+EDXAPP_COMPREHENSIVE_THEME_DIRS:
+  - "{{ EDXAPP_COMPREHENSIVE_THEME_DIR }}"
+# Name of the default site theme
+EDXAPP_DEFAULT_SITE_THEME: "edx-theme-codebase"
+EDXAPP_ENABLE_COMPREHENSIVE_THEMING: true
+
+# EDX API KEY
+EDXAPP_EDX_API_KEY: "test"
+EDXAPP_EDXAPP_SECRET_KEY: "secret_key"