thirdparty/google_appengine/README
changeset 109 620f9b141567
child 149 f2e327a7c5de
equal deleted inserted replaced
108:261778de26ff 109:620f9b141567
       
     1 Copyright 2008 Google Inc.
       
     2 All rights reserved.
       
     3 
       
     4 App Engine SDK - Development tools for Google App Engine
       
     5 
       
     6 CONTENTS
       
     7 ========
       
     8 
       
     9    * Installing on Mac OSX
       
    10    * Installing on Windows
       
    11    * Installing on Linux and other platforms
       
    12    * Running the SDK
       
    13    * Using the SDK
       
    14 
       
    15 
       
    16 INSTALLING ON Mac OSX
       
    17 =====================
       
    18 1) Download and install Python 2.5 from http://www.python.org/download/
       
    19 2) Download the SDK installer from http://code.google.com/appengine/downloads
       
    20 3) Install the SDK by double-clicking on the GoogleAppEngine.dmg file and 
       
    21 running the installer.
       
    22 
       
    23 
       
    24 INSTALLING ON WINDOWS
       
    25 =====================
       
    26 1) Download and install Python 2.5 from http://www.python.org/download/
       
    27 2) Download the SDK installer from http://code.google.com/appengine/downloads
       
    28 2) Install the SDK by double-clicking on the GoogleAppEngine.msi file and 
       
    29 running the installer.
       
    30 
       
    31 
       
    32 INSTALLING ON LINUX AND OTHER PLATFORMS
       
    33 ===============================
       
    34 1) Download and install Python 2.5 from http://www.python.org/download/
       
    35 2) Download the SDK zip file from http://code.google.com/appengine/downloads
       
    36 3) Unpack the zip file.
       
    37 
       
    38 
       
    39 RUNNING THE SDK
       
    40 =========================
       
    41 You can run the SDK with the following command:
       
    42 
       
    43 dev_appserver.py [options] <application root>
       
    44 
       
    45 Application root must be the path to the application to run in this server.
       
    46 Must contain a valid app.yaml or app.yml file.
       
    47 
       
    48 Options:
       
    49   --help, -h                 View this helpful message.
       
    50   --debug, -d                Use debug logging. (Default false)
       
    51   --clear_datastore, -c      Clear the Datastore on startup. (Default false)
       
    52   --address=ADDRESS, -a ADDRESS
       
    53                              Address to which this server should bind. (Default
       
    54                              localhost).
       
    55   --port=PORT, -p PORT       Port for the server to run on. (Default 8080)
       
    56   --datastore_path=PATH      Path to use for storing Datastore file stub data.
       
    57                              (Default /tmp/dev_appserver.datastore)
       
    58   --history_path=PATH        Path to use for storing Datastore history.
       
    59                              (Default /tmp/dev_appserver.datastore.history)
       
    60   --require_indexes          Disallows queries that require composite indexes
       
    61                              not defined in index.yaml.
       
    62   --smtp_host=HOSTNAME       SMTP host to send test mail to.  Leaving this
       
    63                              unset will disable SMTP mail sending.
       
    64                              (Default '')
       
    65   --smtp_port=PORT           SMTP port to send test mail to.
       
    66                              (Default 25)
       
    67   --smtp_user=USER           SMTP user to connect as.  Stub will only attempt
       
    68                              to login if this field is non-empty.
       
    69                              (Default '').
       
    70   --smtp_password=PASSWORD   Password for SMTP server.
       
    71                              (Default '')
       
    72   --enable_sendmail          Enable sendmail when SMTP not configured.
       
    73                              (Default false)
       
    74   --auth_domain              Authorization domain that this app runs in.
       
    75                              (Default gmail.com)
       
    76   --debug_imports            Enables debug logging for module imports, showing
       
    77                              search paths used for finding modules and any
       
    78                              errors encountered during the import process.
       
    79 
       
    80 
       
    81 
       
    82 USING THE SDK
       
    83 =======================
       
    84 For instructions on getting started with Google App Engine, please see the 
       
    85 Google App Engine Getting Started Guide
       
    86 
       
    87 http://code.google.com/appengine/docs/gettingstarted