github.com/graybobo/golang.org-package-offline-cache@v0.0.0-20200626051047-6608995c132f/x/tools/cmd/godoc/README.godoc-app (about)

     1  godoc on appengine
     2  ------------------
     3  
     4  Prerequisites
     5  -------------
     6  
     7  * Go appengine SDK
     8    https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_for_Go
     9  
    10  * Go sources at tip under $GOROOT
    11  
    12  * Godoc sources at tip inside $GOPATH
    13    (go get -d golang.org/x/tools/cmd/godoc)
    14  
    15  
    16  Directory structure
    17  -------------------
    18  
    19  * Let $APPDIR be the directory containing the app engine files.
    20    (e.g., $APPDIR=$HOME/godoc-app)
    21  
    22  * $APPDIR contains the following entries (this may change depending on
    23    app-engine release and version of godoc):
    24  
    25  	app.yaml
    26  	golang.org/x/tools/cmd/godoc
    27  	godoc.zip
    28  	index.split.*
    29  
    30  * The app.yaml file is set up per app engine documentation.
    31    For instance:
    32  
    33  	application: godoc-app
    34  	version: 1
    35  	runtime: go
    36  	api_version: go1
    37  
    38  	handlers:
    39  	- url: /.*
    40  	  script: _go_app
    41  
    42  
    43  Configuring and running godoc
    44  -----------------------------
    45  
    46  To configure godoc, run
    47  
    48  	bash setup-godoc-app.bash
    49  
    50  to prepare an $APPDIR as described above. See the script for details on usage.
    51  
    52  To run godoc locally, using the App Engine development server, run
    53  
    54  	<path to go_appengine>/dev_appserver.py $APPDIR
    55  
    56  godoc should come up at http://localhost:8080 .