OBJ/WebHosting: Difference between revisions

Jump to navigation Jump to search
Line 50: Line 50:
'''''Using the CLI:'''''<br>
'''''Using the CLI:'''''<br>
Enter the following command in the terminal: <code>webobj -m delete -c website <bucket_name></code>
Enter the following command in the terminal: <code>webobj -m delete -c website <bucket_name></code>
'''''Using a Graphical S3 Client (Cyberduck):'''''<br>
# Right-click on the bucket where you are hosting your website and click <code>info</code>.
# Uncheck the box

* [https://gitlab.umiacs.umd.edu/staff/umobj/blob/master/README.md| More commands for umobj]
* [https://gitlab.umiacs.umd.edu/staff/umobj/blob/master/README.md| More commands for umobj]
* [[S3Clients]]
* [[S3Clients]]

Revision as of 13:47, 27 August 2021

On the settings page for each bucket, there is a section allowing you to specify a configuration for a website hosted in your bucket. You can choose keys located in your bucket to act as the index file (what will be displayed when someone visits your website) and the error file (what will be displayed when an error is encountered loading your website). These settings can be updated at any time.

Because hosting a website through your bucket requires others to have access to any keys associated with your website, setting up a website configuration will automatically set the visibility of your bucket to public and remove the bucket level ACLs. You will not be able to set the bucket back to private without first removing the website configuration, which can be done on the bucket settings page.

The Object Store only has the capability to support static content and client-side scripting in bucket websites.

Hosting a Website

Hosting a website in OBJ is quite easy and can be done in a few simple steps. There are three different ways you can set up your OBJ bucket to host a static website.

First Method (Using the Web Interface):

  1. Log into OBJ and create a bucket. Make sure to choose a bucket name carefully since this will be part of the web URL.
    Bucket settings01.jpg
  2. Upload your index.html file and optional error.html file (and any other required files for your website) on the bucket that you just created.
  3. Once the files are uploaded, click on Bucket Settings
  4. On the settings page, click on the blue Make Public button.
    Bucket settings.jpg
  5. Under Website Hosting, enter the name of your index.html (and optionally error.html) file and hit Submit.

Second Method (Using the UMobj CLI):

  1. Set up your environment variables.
  2. On the shell enter mkobj <bucket_name> to create a bucket. Your bucket name must be unique. You can enter lsobj -l to see the existing buckets.
  3. Copy all the required files to the bucket: cpobj [source_directory]/file_name <bucket_name>:. For example, cpobj /fs/www-users/jayid-test/index.html jayid-test:
  4. Create a web configuration for your bucket: webobj -m create -c website --index=index.html --error=error.html <bucket_name>
  5. Make your bucket public: chobj -m public <bucket_name>

Third Method (Using a Graphical S3 Client):
Since there are many different graphical clients available, we won't be able to cover detailed instructions for all of them. The instruction below only applies to Cyberduck.

  1. Please refer to S3Clients to download and install Cyberduck.
  2. Log into Cyberduck using the instruction from the previous step.
  3. Once logged in, right-click > New Folder.... Give a unique name to your bucket.
  4. Right-click on the bucket you just created, and click on Upload.... You can upload multiple files at once.
  5. Once all the files are uploaded, right-click on the same bucket, and click on info.
  6. Under the Distribution (CDN) tab make sure to leave a checkmark next to Enable Website Configuration (HTTP) Distribution.
  7. Next, click on the drop-down menu next to Index File and select your index.html file (or whatever file you're using as your index file).
  8. Under the Permission tab, add a permission by clicking on the cog icon on the bottom left and click on Everyone. Change the permission for Everyone to READ as shown on the image below.<

Note: Once the bucket is configured and all the required files are uploaded, please log into your UMIACS Directory and update the Home Page attribute to http://<Bucket_name>.umiacs.io. Replace <Bucket_name> with the name of the bucket you created.

Accessing the Website

  • You can access your personal website by using the default URL which has the form http://<Bucket_name>.umiacs.io.
  • Alternatively, you can also visit www.umiacs.umd.edu/~username to visit your website. However, please ensure that the Home Page attribute in your UMIACS Directory is set to http://<Bucket_name>.umiacs.io for this link to work.

Disabling a Website

If you no longer wish to host a website, you can disable the bucket's web configuration.
Using the web interface:

  1. Click on the bucket where you are hosting your website and then click on Bucket Settings.
  2. On the settings page you can, click on Remove Website Configuration. Alternatively, you can also click on the Make Private button to make your bucket private and remove any associated web configuration.

Using the CLI:
Enter the following command in the terminal: webobj -m delete -c website <bucket_name>

Using a Graphical S3 Client (Cyberduck):

  1. Right-click on the bucket where you are hosting your website and click info.
  2. Uncheck the box