vulndb/webconfig
Tatiana Bradley bcd4554fa9 deploy: rename index to index.html
In all future deploys, deploy index.html file as "index.html" instead of
"index", to avoid a naming conflict with the new "index/" folder.

Instructions in README are also updated accordingly.

Change-Id: I9f9e5bb994cb53afe0945459acbbe753234ed3a9
Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/473755
Reviewed-by: Julie Qiu <julieqiu@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Tatiana Bradley <tatianabradley@google.com>
2023-03-06 19:27:34 +00:00
..
404.html webconfig: add privacy policy 2022-08-08 17:32:04 +00:00
README.md deploy: rename index to index.html 2023-03-06 19:27:34 +00:00
copyright.html webconfig: add copyright page 2022-08-16 23:18:52 +00:00
favicon.ico webconfig: improve html and add favicon 2022-06-07 15:21:49 +00:00
index.html webconfig, deploy: remove .html suffix from web files 2022-10-31 21:09:38 +00:00
privacy.html webconfig: add privacy policy 2022-08-08 17:32:04 +00:00

README.md

Go Vulnerability Database Web Configuration

These files control what users see when they visit vuln.go.dev, and when they get a 404 on that site.

Deployment

Every time a new CL is submitted, the existing .html and .ico files in this folder are automatically copied to the vuln DB bucket via the script in deploy/gcp-deploy.sh.

If a new file is added, update the script in deploy/gcp-deploy.sh and below.

Manual deployment

In exceptional cases, the files may need to be manually copied into the bucket. To do this, run this script:

gsutil cp webconfig/index.html gs://go-vulndb
for file in 404 copyright privacy; do
    gsutil -h "Content-Type:text/html" cp webconfig/$file.html gs://go-vulndb/$file
done
gsutil cp webconfig/favicon.ico gs://go-vulndb

This requires golang-vulndb-project-owners rights, which must be requested and approved via Access on Demand (go/get-aod).

Initial Setup

The initial setup has already been completed and no further action is required.

The go-vulndb bucket was configured to display these pages via:

gsutil web set -m index.html -e 404 gs://go-vulndb

Use gsutil web get gs://go-vulndb to display the current configuration.