Set the website configuration on a bucket

Set the static website configuration for a Cloud Storage bucket.

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

C++

For more information, see the Cloud Storage C++ API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  namespace 
  
 gcs 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 storage 
 ; 
 using 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 StatusOr 
 ; 
 []( 
 gcs 
 :: 
 Client 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_name 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 main_page_suffix 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 not_found_page 
 ) 
  
 { 
  
 StatusOr<gcs 
 :: 
 BucketMetadata 
>  
 original 
  
 = 
  
 client 
 . 
 GetBucketMetadata 
 ( 
 bucket_name 
 ); 
  
 if 
  
 ( 
 ! 
 original 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 original 
 ). 
 status 
 (); 
  
 StatusOr<gcs 
 :: 
 BucketMetadata 
>  
 patched 
  
 = 
  
 client 
 . 
 PatchBucket 
 ( 
  
 bucket_name 
 , 
  
 gcs 
 :: 
 BucketMetadataPatchBuilder 
 (). 
 SetWebsite 
 ( 
  
 gcs 
 :: 
 BucketWebsite 
 { 
 main_page_suffix 
 , 
  
 not_found_page 
 }), 
  
 gcs 
 :: 
 IfMetagenerationMatch 
 ( 
 original 
 - 
> metageneration 
 ())); 
  
 if 
  
 ( 
 ! 
 patched 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 patched 
 ). 
 status 
 (); 
  
 if 
  
 ( 
 ! 
 patched 
 - 
> has_website 
 ()) 
  
 { 
  
 std 
 :: 
 cout 
 << 
 "Static website configuration is not set for bucket " 
 << 
 patched 
 - 
> name 
 () 
 << 
 " 
 \n 
 " 
 ; 
  
 return 
 ; 
  
 } 
  
 std 
 :: 
 cout 
 << 
 "Static website configuration successfully set for bucket " 
 << 
 patched 
 - 
> name 
 () 
 << 
 " 
 \n 
 New main page suffix is: " 
 << 
 patched 
 - 
> website 
 (). 
 main_page_suffix 
 << 
 " 
 \n 
 New not found page is: " 
 << 
 patched 
 - 
> website 
 (). 
 not_found_page 
 << 
 " 
 \n 
 " 
 ; 
 }

C#

For more information, see the Cloud Storage C# API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  using 
  
 Google.Apis.Storage.v1.Data 
 ; 
 using 
  
  Google.Cloud.Storage.V1 
 
 ; 
 using 
  
 System 
 ; 
 public 
  
 class 
  
 BucketWebsiteConfigurationSample 
 { 
  
 public 
  
 Bucket 
  
 BucketWebsiteConfiguration 
 ( 
  
 string 
  
 bucketName 
  
 = 
  
 "your-bucket-name" 
 , 
  
 string 
  
 mainPageSuffix 
  
 = 
  
 "index.html" 
 , 
  
 string 
  
 notFoundPage 
  
 = 
  
 "404.html" 
 ) 
  
 { 
  
 var 
  
 storage 
  
 = 
  
  StorageClient 
 
 . 
  Create 
 
 (); 
  
 var 
  
 bucket 
  
 = 
  
 storage 
 . 
 GetBucket 
 ( 
 bucketName 
 ); 
  
 if 
  
 ( 
 bucket 
 . 
 Website 
  
 == 
  
 null 
 ) 
  
 { 
  
 bucket 
 . 
 Website 
  
 = 
  
 new 
  
 Bucket 
 . 
 WebsiteData 
 (); 
  
 } 
  
 bucket 
 . 
 Website 
 . 
 MainPageSuffix 
  
 = 
  
 mainPageSuffix 
 ; 
  
 bucket 
 . 
 Website 
 . 
 NotFoundPage 
  
 = 
  
 notFoundPage 
 ; 
  
 bucket 
  
 = 
  
 storage 
 . 
 UpdateBucket 
 ( 
 bucket 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Static website bucket {bucketName} is set up to use {mainPageSuffix} as the index page and {notFoundPage} as the 404 not found page." 
 ); 
  
 return 
  
 bucket 
 ; 
  
 } 
 }

Go

For more information, see the Cloud Storage Go API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "time" 
  
 "cloud.google.com/go/storage" 
 ) 
 // setBucketWebsiteInfo sets website configuration on a bucket. 
 func 
  
 setBucketWebsiteInfo 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 bucketName 
 , 
  
 indexPage 
 , 
  
 notFoundPage 
  
 string 
 ) 
  
 error 
  
 { 
  
 // bucketName := "www.example.com" 
  
 // indexPage := "index.html" 
  
 // notFoundPage := "404.html" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 storage 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "storage.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 ctx 
 , 
  
 cancel 
  
 := 
  
 context 
 . 
 WithTimeout 
 ( 
 ctx 
 , 
  
 time 
 . 
 Second 
 * 
 10 
 ) 
  
 defer 
  
 cancel 
 () 
  
 bucket 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucketName 
 ) 
  
 bucketAttrsToUpdate 
  
 := 
  
 storage 
 . 
  BucketAttrsToUpdate 
 
 { 
  
 Website 
 : 
  
& storage 
 . 
  BucketWebsite 
 
 { 
  
 MainPageSuffix 
 : 
  
 indexPage 
 , 
  
 NotFoundPage 
 : 
  
 notFoundPage 
 , 
  
 }, 
  
 } 
  
 if 
  
 _ 
 , 
  
 err 
  
 := 
  
 bucket 
 . 
 Update 
 ( 
 ctx 
 , 
  
 bucketAttrsToUpdate 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Update: %w" 
 , 
  
 bucketName 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Static website bucket %v is set up to use %v as the index page and %v as the 404 page\n" 
 , 
  
 bucketName 
 , 
  
 indexPage 
 , 
  
 notFoundPage 
 ) 
  
 return 
  
 nil 
 }

Java

For more information, see the Cloud Storage Java API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 com.google.cloud.storage. Bucket 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 public 
  
 class 
 SetBucketWebsiteInfo 
  
 { 
  
 public 
  
 static 
  
 void 
  
 setBucketWesbiteInfo 
 ( 
  
 String 
  
 projectId 
 , 
  
 String 
  
 bucketName 
 , 
  
 String 
  
 indexPage 
 , 
  
 String 
  
 notFoundPage 
 ) 
  
 { 
  
 // The ID of your GCP project 
  
 // String projectId = "your-project-id"; 
  
 // The ID of your static website bucket 
  
 // String bucketName = "www.example.com"; 
  
 // The index page for a static website bucket 
  
 // String indexPage = "index.html"; 
  
 // The 404 page for a static website bucket 
  
 // String notFoundPage = "404.html"; 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 setProjectId 
 ( 
 projectId 
 ). 
 build 
 (). 
  getService 
 
 (); 
  
  Bucket 
 
  
 bucket 
  
 = 
  
 storage 
 . 
  get 
 
 ( 
 bucketName 
 ); 
  
 bucket 
 . 
  toBuilder 
 
 (). 
 setIndexPage 
 ( 
 indexPage 
 ). 
 setNotFoundPage 
 ( 
 notFoundPage 
 ). 
 build 
 (). 
 update 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
  
 "Static website bucket " 
  
 + 
  
 bucketName 
  
 + 
  
 " is set up to use " 
  
 + 
  
 indexPage 
  
 + 
  
 " as the index page and " 
  
 + 
  
 notFoundPage 
  
 + 
  
 " as the 404 page" 
 ); 
  
 } 
 }

Node.js

For more information, see the Cloud Storage Node.js API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
 // The ID of your GCS bucket 
 // const bucketName = 'your-unique-bucket-name'; 
 // The name of the main page 
 // const mainPageSuffix = 'http://example.com'; 
 // The Name of a 404 page 
 // const notFoundPage = 'http://example.com/404.html'; 
 // Imports the Google Cloud client library 
 const 
  
 { 
 Storage 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage 
' 
 ); 
 // Creates a client 
 const 
  
 storage 
  
 = 
  
 new 
  
 Storage 
 (); 
 async 
  
 function 
  
 addBucketWebsiteConfiguration 
 () 
  
 { 
  
 await 
  
 storage 
 . 
 bucket 
 ( 
 bucketName 
 ). 
 setMetadata 
 ({ 
  
 website 
 : 
  
 { 
  
 mainPageSuffix 
 , 
  
 notFoundPage 
 , 
  
 }, 
  
 }); 
  
 console 
 . 
 log 
 ( 
  
 `Static website bucket 
 ${ 
 bucketName 
 } 
 is set up to use 
 ${ 
 mainPageSuffix 
 } 
 as the index page and 
 ${ 
 notFoundPage 
 } 
 as the 404 page` 
  
 ); 
 } 
 addBucketWebsiteConfiguration 
 (). 
 catch 
 ( 
 console 
 . 
 error 
 );

PHP

For more information, see the Cloud Storage PHP API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  use Google\Cloud\Storage\StorageClient; 
 /** 
 * Update the given bucket's website configuration. 
 * 
 * @param string $bucketName The name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 * @param string $indexPageObject the name of an object in the bucket to use as 
 *        (e.g. 'index.html') 
 *     an index page for a static website bucket. 
 * @param string $notFoundPageObject the name of an object in the bucket to use 
 *        (e.g. '404.html') 
 *     as the 404 Not Found page. 
 */ 
 function define_bucket_website_configuration(string $bucketName, string $indexPageObject, string $notFoundPageObject): void 
 { 
 $storage = new StorageClient(); 
 $bucket = $storage->bucket($bucketName); 
 $bucket->update([ 
 'website' => [ 
 'mainPageSuffix' => $indexPageObject, 
 'notFoundPage' => $notFoundPageObject 
 ] 
 ]); 
 printf( 
 'Static website bucket %s is set up to use %s as the index page and %s as the 404 page.', 
 $bucketName, 
 $indexPageObject, 
 $notFoundPageObject 
 ); 
 }

Python

For more information, see the Cloud Storage Python API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  from 
  
 google.cloud 
  
 import 
  storage 
 
 def 
  
 define_bucket_website_configuration 
 ( 
 bucket_name 
 , 
 main_page_suffix 
 , 
 not_found_page 
 ): 
  
 """Configure website-related properties of bucket""" 
 # bucket_name = "your-bucket-name" 
 # main_page_suffix = "index.html" 
 # not_found_page = "404.html" 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 bucket 
 = 
 storage_client 
 . 
  get_bucket 
 
 ( 
 bucket_name 
 ) 
 bucket 
 . 
  configure_website 
 
 ( 
 main_page_suffix 
 , 
 not_found_page 
 ) 
 bucket 
 . 
 patch 
 () 
 print 
 ( 
 "Static website bucket 
 {} 
 is set up to use 
 {} 
 as the index page and 
 {} 
 as the 404 page" 
 . 
 format 
 ( 
 bucket 
 . 
 name 
 , 
 main_page_suffix 
 , 
 not_found_page 
 ) 
 ) 
 return 
 bucket

Ruby

For more information, see the Cloud Storage Ruby API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  def 
  
 define_bucket_website_configuration 
  
 bucket_name 
 :, 
  
 main_page_suffix 
 :, 
  
 not_found_page 
 : 
  
 # The ID of your static website bucket 
  
 # bucket_name = "www.example.com" 
  
 # The index page for a static website bucket 
  
 # main_page_suffix = "index.html" 
  
 # The 404 page for a static website bucket 
  
 # not_found_page = "404.html" 
  
 require 
  
 "google/cloud/storage" 
  
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
  
 bucket 
  
 = 
  
 storage 
 . 
 bucket 
  
 bucket_name 
  
 bucket 
 . 
 update 
  
 do 
  
 | 
 b 
 | 
  
 b 
 . 
  website_main 
 
  
 = 
  
 main_page_suffix 
  
 b 
 . 
  website_404 
 
  
 = 
  
 not_found_page 
  
 end 
  
 puts 
  
 "Static website bucket 
 #{ 
 bucket_name 
 } 
 is set up to use 
 #{ 
 main_page_suffix 
 } 
 as the index page and " 
  
 \ 
  
 " 
 #{ 
 not_found_page 
 } 
 as the 404 page" 
 end

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .