Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(240)

Side by Side Diff: chrome/common/extensions/docs/server2/README

Issue 139303023: add GCS support to docs server (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Updated third party library, rebased and fixed a path issue caused by rebasing Created 6 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 -------- 1 --------
2 Overview 2 Overview
3 3
4 This is a Google App Engine server which serves the documentation for Chrome 4 This is a Google App Engine server which serves the documentation for Chrome
5 apps and extensions. At time of this writing, the primary URL is: 5 apps and extensions. At time of this writing, the primary URL is:
6 http://developer.chrome.com/. 6 http://developer.chrome.com/.
7 7
8 8
9 --------------------- 9 ---------------------
10 Developing the Server 10 Developing the Server
11 11
12 You shouldn't need app engine locally to develop the server, preview.py should 12 You shouldn't need app engine locally to develop the server, preview.py should
13 be sufficient. If for some reason you want to test against the app engine SDK: 13 be sufficient. If for some reason you want to test against the app engine SDK:
14 14
15 1. Download the python Google App Engine SDK from: 15 1. Download the python Google App Engine SDK from:
16 https://developers.google.com/appengine/downloads 16 https://developers.google.com/appengine/downloads
17 17
18 2. Run './start_dev_server.py <path/to/dev_appserver.py>' 18 2. Run './start_dev_server.py <path/to/dev_appserver.py>'
19 (dev_appserver.py is part of the App Engine) 19 (dev_appserver.py is part of the App Engine)
20 20
21 3. View docs at http://localhost:8080/(apps|extensions)/<doc_name> 21 3. View docs at http://localhost:8080/(apps|extensions)/<doc_name>
22 22
23 23
24 --------------------------------------------
25 Using Google Cloud Storage content providers
26
27 With preview.py:
28
29 1. create a directory "[...]/server2/local_debug/gcs/<bucketname>" for every
30 gcs bucket referenced in content_providers.json
31
32 2. copy files to the respective local bucket directories. Preview.py has
33 no access to the real Google Cloud Storage.
34
35 With start_dev_server.py:
36
37 1. Install gsutils from https://developers.google.com/storage/docs/gsutil
38
39 2. Set gsutil accordingly to the official instructions.
40
41 3. Make sure you have permission to the GCS buckets specified in
42 content_providers.json by running "gsutil ls gs://bucketname"
43
44 4. Get an oauth token (see instructions at the comment of
45 gcs_file_system_provider.py) and save it to the file
46 "[...]/server2/local_debug/gcs_debug.conf"
47
48 Remember that the step 4 needs to be repeated every 10 minutes or so,
49 because the oauth access token expires quickly.
50
24 -------------------- 51 --------------------
25 Deploying the Server 52 Deploying the Server
26 53
27 You will need to have access to the http://chrome-apps-doc.appspot.com app. 54 You will need to have access to the http://chrome-apps-doc.appspot.com app.
28 Contact aa@chromium.org, erikkay@chromium.org, miket@chromium.org, 55 Contact aa@chromium.org, erikkay@chromium.org, miket@chromium.org,
29 kalman@chromium.org, or ernestd@chromium.org to obtain access. 56 kalman@chromium.org, or ernestd@chromium.org to obtain access.
30 57
31 Once you have access: 58 Once you have access:
32 59
33 1. Increment the version in app.yaml so we can roll back if the update breaks. 60 1. Increment the version in app.yaml so we can roll back if the update breaks.
34 61
35 2. Run build_server.py. This copies some depenencies from /third_party into the 62 2. Run build_server.py. This copies some depenencies from /third_party into the
36 server directory so that they get uploaded to App Engine. 63 server directory so that they get uploaded to App Engine.
37 64
38 3. Run appcfg.py (supplied with the App Engine SDK) to upload the server code: 65 3. Run appcfg.py (supplied with the App Engine SDK) to upload the server code:
39 66
40 appcfg.py update . 67 appcfg.py update .
41 68
42 4. When prompted for your credentials, enter the information for the account 69 4. When prompted for your credentials, enter the information for the account
43 that has access to the production app. 70 that has access to the production app.
44 71
45 5. Go to http://www.appspot.com, select the docs project, click "versions" in 72 5. Go to http://www.appspot.com, select the docs project, click "versions" in
46 the sidebar, and make the version you just deployed the "default" version. 73 the sidebar, and make the version you just deployed the "default" version.
47 74
48 If you get an error about too many versions when deploying, go into this 75 If you get an error about too many versions when deploying, go into this
49 view and delete the version which was deployed the longest time ago. Then 76 view and delete the version which was deployed the longest time ago. Then
50 try to deploy again. 77 try to deploy again.
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/server2/.gitignore ('k') | chrome/common/extensions/docs/server2/app.yaml » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698