To use the Hosting feature of Storage3, you can deploy the decentralized version of your website in Storage3 after being authorized by the GitHub repository. You can update the deploy if there are any GitHub updates in the future.

Concepts

The chart below illustrates major entities in Storage3's Hosting and their relations, which will help you to understand Storage3 hosting better. But of course, you can skip it if you want to.

12001200

Connecting to BTTC

800800

You need a BTTC address to start your Storage3 journey. Click here to learn more about BTTC.

Go to Storage3's website, click "Enter App", and log into the BTTC network through Metamask.

784784

Site Deployment

After logging in, select the Hosting tab, and you can see all your deployed projects here. If there is no project, click Add New Hosting on the bottom to create your first website deploy.

800800

The three steps to deploying a new project are as follows:

12001200

1. Connect to Github
Log in and connect to your GitHub account

2. Choose a Repo
Select in your GitHub account the repository you want to deploy

3. Settings & Deploy
Select a branch you want to make the deployment, choose the settings (explained below), and execute the deployment.

800800

📘

Deploy Settings Explanation

Framework —— The preset image configuration, if you need to customize, please select Other.

Docker image Name —— The docker image and tag from the Docker Hub to use as a base when building your site.

Build Command —— The build command to run before deploying. Examples: build, gulp build, make all.

Publish Directory —— The directory to deploy after running the build command. Examples: _site, dist, public.

Base Directory —— The directory which contains the site's source code. Other parameters, such as the build commands, are performed in relation with base directory.

Project Details

After the first deploy of a project, you can view the project details:

Info —— including project name, owner, GitHub Repo/Branch.
Deploys —— which displays all the project's deploys and their status.
Settings —— in which you can change the site name and delete the project.

12001200

Deployment Details

12001200

Click any deploy under the “Deploys tab” to view the details, including:

Status —— Status of the current deploy;
Log —— Logs generated during the deployment;
Summary —— Summary information of the deployment.

The following chart presents a full cycle of status change of a deploy.

12001200

Change Site Name

Users can access your sites via gateway.btfs.io/btfs/{CID} or foo.on.btfs.io which is a more user-friendly domain name.
A random site name will be generated after the first deployment of a project. You can change the site name in Settings .

12001200

Sub-Domain URL & Gateway Hash URL

16001600

Update Deploy

You may want to deploy new content when there is an update on GitHub. Click Trigger Deploy under the DEPLOYS tab to update your deploy.

12001200

Delete Sites

You may delete a site when it is no longer used. Please note that you need to re-deploy the deleted site as it cannot be retrieved once deleted.

12001200