commit de0cfe5ecdfa3b85bd28d155b3ebef7faf490160 Author: Ximin Luo <infinity0@gmx.com> Date: Mon Nov 18 16:32:14 2013 +0000 merge appengine/README into config.go, mention --no_cookies and testing on a separate machine --- facilitator/Makefile.am | 2 +- facilitator/appengine/README | 11 ----------- facilitator/appengine/config.go | 10 ++++++++++ facilitator/doc/appspot-howto.txt | 34 ++++++++++++++++++++++++---------- 4 files changed, 35 insertions(+), 22 deletions(-) diff --git a/facilitator/Makefile.am b/facilitator/Makefile.am index 2b3ac8e..784ec2d 100644 --- a/facilitator/Makefile.am +++ b/facilitator/Makefile.am @@ -26,7 +26,7 @@ endif dist_doc_DATA = doc/appspot-howto.txt doc/facilitator-design.txt doc/email-howto.txt doc/http-howto.txt doc/server-howto.txt README dist_example_DATA = examples/fp-facilitator.conf examples/reg-email.pass examples/facilitator-relays pkgconf_DATA = examples/facilitator-relays -dist_appengine_DATA = appengine/app.yaml appengine/config.go appengine/fp-reg.go appengine/README +dist_appengine_DATA = appengine/app.yaml appengine/config.go appengine/fp-reg.go appengineconf_DATA = appengine/config.go CLEANFILES = examples/fp-facilitator.conf EXTRA_DIST = examples/fp-facilitator.conf.in $(TESTS) diff --git a/facilitator/appengine/README b/facilitator/appengine/README deleted file mode 100644 index 95215d3..0000000 --- a/facilitator/appengine/README +++ /dev/null @@ -1,11 +0,0 @@ -This is the server-side code that runs on Google App Engine for the -"appspot" registration method. - -See doc/appspot-howto.txt for information about setting up an -application. - -To run locally using the development server: -$ ~/google_appengine/dev_appserver.py . - -To upload a new version: -$ torify ~/google_appengine/appcfg.py -A $YOUR_APP_ID update . diff --git a/facilitator/appengine/config.go b/facilitator/appengine/config.go index 0f2ffb1..20898e0 100644 --- a/facilitator/appengine/config.go +++ b/facilitator/appengine/config.go @@ -1,3 +1,13 @@ +/* +This is the server-side code that runs on Google App Engine for the +"appspot" registration method. + +See doc/appspot-howto.txt for more details about setting up an +application, and advice on running one. + +To upload a new version: +$ torify ~/go_appengine/appcfg.py --no_cookies -A $YOUR_APP_ID update . +*/ package fp_reg // host:port/basepath of the facilitator you want to register with diff --git a/facilitator/doc/appspot-howto.txt b/facilitator/doc/appspot-howto.txt index 9202417..8ed1284 100644 --- a/facilitator/doc/appspot-howto.txt +++ b/facilitator/doc/appspot-howto.txt @@ -5,13 +5,12 @@ ensure it is working correctly, or find someone else's to use. If you choose the latter, note that it is *their* reg-daemon.pub that your users must give to flashproxy-reg-appspot. -General links: -https://developers.google.com/appengine/ -https://developers.google.com/appengine/docs/whatisgoogleappengine -https://developers.google.com/appengine/docs/go/gettingstarted/ +For more information about Google App Engine, see the links at the bottom +of this document. -You first need to create a Google account. See email-howto.txt for how -to do that. +You are strongly recommended to create a Google account dedicated for +this purpose, rather than a personal or organisation account. See +email-howto.txt for how to do that. Download the SDK: https://developers.google.com/appengine/docs/go/gettingstarted/devenvironmen... @@ -24,10 +23,15 @@ Follow the directions to register a new application: https://developers.google.com/appengine/docs/go/gettingstarted/uploading Enter an application ID and create the application. +To run locally using the development server: +$ ~/go_appengine/dev_appserver.py reg-appspot/ +You are advised to do this on a non-production machine, away from the main +facilitator. + Use the appcfg.py program to upload the program. It should look something like this: -$ torify ./google_appengine/appcfg.py -A <YOUR_APP_ID> update reg-appspot/ +$ torify ./google_appengine/appcfg.py --no_cookies -A <YOUR_APP_ID> update reg-appspot/ 07:25 PM Host: appengine.google.com 07:25 PM Application: application-id; version: 1 07:25 PM @@ -48,11 +52,21 @@ Password for xxx@gmail.com: 07:26 PM Checking if updated app version is serving. 07:26 PM Completed update of app: application-id, version: 1 -Uploading the program in this way seems to create the files -~/.appcfg_nag and ~/.appcfg_cookies. Running the update command again -doesn't require you to enter your password again. +The --no_cookies flag stops authentication cookies from being written +to disk, in ~/.appcfg_cookies. We recommend this for security, since no +long-running services need this password, only the update process above +which is run once. However, if this reasoning doesn't apply to you +(e.g. if your facilitator-email-poller uses the same account, so that +the password is already on the disk) *and* you find yourself running +update a lot for some reason, then you may at your own risk omit it for +convenience. Once logged in, you can disable logging for the application. Click "Logs" on the left panel. Under "Total Logs Storage", click "Change Settings". Enter "0" in the "days of logs" box and click "Save Settings". + +General links: +https://developers.google.com/appengine/ +https://developers.google.com/appengine/docs/whatisgoogleappengine +https://developers.google.com/appengine/docs/go/gettingstarted/