Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

AdminSetup

Jump to bottom
Maxim Ermilov edited this page Dec 3, 2018 · 11 revisions

Introduction

Building Cauliflower Vest requires Apple's OS X 10.10 or later, python 2.7, bazel and other third-party packages.

Download Cauliflower Vest

Estimated Time: 1 minute

Cauliflower Vest is available for download via Git:

Download and Install XCode

Estimated Time: 10-60 minutes

Download and Install XCode

Xcode, a free download from Apple, is required to build Cauliflower Vest. Cauliflower Vest requires v4.2 or higher. v4.3 is available here:

Download and Install Command Line Tools

Starting with 4.3 Apple has removed the Command Line Tools and PackageMaker from Xcode, therefore they now must be installed manually. They're available from the Apple Developer Tools site, which requires a (free) Apple developer account:

Alternatively, the Command Line Tools may be installed within Xcode via Xcode -> Preferences -> Downloads

Download and Install bazel

  1. Visit https://docs.bazel.build/versions/master/install.html

Building and Testing

Note: This section is subject to change in a imminent release.

Estimated Time: 1-5 minutes

pip install pycrypto pillow

Once untarring Cauliflower Vest, run:

bazel test cauliflowervest:all_smoke_tests

to build and run tests. Dependency problems will be shaken out in the beginning and should be automatically satisfied.

Test Results

Estimated Time: 30 seconds

It is important that all tests pass before you continue.

See Testing for more details about the testing step.

Obtain an App Engine instance

Estimated Time: 3 minutes

  1. Visit http://appengine.google.com and click Create Application to create a new application, taking note of the Application Identifier, appid, you chose. * It's highly recommended that you restrict access to your Google Apps domain under Authentication Options.

Configuration and App Engine deployment

Estimated Time: 5 minutes

See the Configuration wiki page for information about configuring your client and server.

Once complete:

  1. Edit cauliflowervest/settings.py changing SUBDOMAIN and DOMAIN to match your App Engine application.
  2. Using the Google Developer's Console, in the "APIs & auth" / "Credentials" section, create a new Client ID for an installed application.
    • The first time, it will be necessary to configure, at a minimum, an application name and support email into the consent screen for the App Engine app, before creating the Client ID.
  3. Edit cauliflowervest/client/settings.py to fill in OAUTH_CLIENT_SECRET with the values generated via the developer's console.
  4. Edit cauliflowervest/settings.py to fill in OAUTH_CLIENT_ID with the values generated via the developer's console.
  5. From the root directory, run bazel run cauliflowervest/server:main.deploy -- --project=YOUR_APP_ID to deploy to App Engine.

Packaging a Deployable Client

Estimated Time: 1 minute

If you've completed the above, you're ready to package a client for deployment. Please see PackagingDeployableClient for more information.

Clone this wiki locally