Amazon S3 sync
Diego Muralles avatar
Written by Diego Muralles
Updated over a week ago

Amazon Simple Storage Service (S3) is a cloud storage service that allows you to store and retrieve any amount of data from anywhere on the web. It is highly scalable, reliable, and secure, making it a popular choice for storing and managing data for businesses and individuals alike.

Adding an AWS S3 to your account

  1. In the dashboard, click on your avatar in the left sidebar and click on Hosting

  2. Click Create hosting

  3. Enter your domain or sub-domain (e.g. www.mywebsite.com) for navigation purposes - you will add your S3 bucket name in the next stage.

  4. Select Advanced hosting option as the hosting option

  5. Choose AWS S3 sync from the list

  6. Decide on the access level (public or private).

  7. Click on Create hosting

โ˜๏ธ Upgrade from the Starter plan to the Professional plan to unlock Amazon S3 sync as an Advanced hosting option!

Setting up an AWS S3 sync

To successfully connect your AWS S3 sync, it's essential to provide several parameters. While some are mandatory, others are optional, depending on your server configuration.

Take a look at the list below to understand each parameter's function:

  • S3 bucket name (required)

    • Specify the name of the destination bucket where your files will be sent.

  • Web root folder

    • Define the folder within the target S3 bucket where Vev will upload your files.

  • Amazon S3 region (required)

    • Select your bucket's region from the available options or provide the endpoint/services URL.

  • Upload AWS access key (required)

    • they need to be generated from IAM in the AWS console. The IAM user should have permissions limited to "s3:PutObject" and "s3:PutObjectAcl" policies for security.

  • Unpublish

    • Enable this option to grant Vev permission to unpublish the content.

Additional settings for your domain

Adding a web path

You can add a path to your domain at the core level, which means it will be used as a base path in all projects to which the domain is added.

Adding a Favicon

A favicon is a visual representation of your web page that helps your user visually identify and distinguish websites when they have multiple tabs open. Simply drag and drop your file into the designated area.

Publishing to your AWS S3 Bucket

After setting up your AWS S3 sync correctly, follow these steps to add it as a publish destination:

  1. Open the project you want to publish

  2. Click the Publish button on the top right corner

  3. Select Add publish destination from the publish dialog

  4. Choose your domain from the dropdown list

  5. Add a path to your domain or leave it blank if you want to publish to its root (the path will only be added at a project level)

  6. Hit Add publish destination

  7. Open the publish dialog

  8. Hit Publish project

To publish to your AWS S3 bucket, you need to upgrade to our Professional plan.

Unpublishing a project

To unpublish your project from your Webhook, you have two options:

  1. Unpublishing from the publish modal

    1. Click on the "Publishing" button to access the Publishing Modal.

    2. In the Publishing Modal, locate your domain.

    3. Click on the overflow menu (represented by three dots) associated with your domain.

    4. From the options displayed, select "Unpublish."

    5. A pop-up menu will appear asking you to confirm your decision. Click on "Unpublish" to proceed.

    6. After confirming, your project will be unpublished. Please note that it may take up to 5 minutes for the changes to take effect, and your page will no longer be accessible.
      โ€‹

  2. Unpublishing from the AWS S3 settings page

    1. In your Webhook settings page, click the "Projects" tab on the left bar

    2. If you have published projects, click the three dots next to the project you want to unpublish and click "Unpublish".

    3. The project will no longer appear on the list.

Choose the option that best suits your workflow to unpublish your project from the Webhook.

If you're having trouble unpublishing your page, we're here to help! Please reach out to our support team for assistance.

Did this answer your question?