Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

missing guide / section on Public pods feature #51

Open
rampall opened this issue Apr 19, 2023 · 1 comment
Open

missing guide / section on Public pods feature #51

rampall opened this issue Apr 19, 2023 · 1 comment

Comments

@rampall
Copy link

rampall commented Apr 19, 2023

A intro section and guide on public pods feature and hosting a website using public pods would be helpful.

@tfius
Copy link
Contributor

tfius commented Apr 20, 2023

DRAFT
Maybe it should focus only on FairOS (here are several options mentioned).

How do I create a pod?

To create a pod, you have several options:

  • you can download Fairdrive Desktop App (FDA) [ADD LINK] and create a pod there, add files and create a shared pod reference.
  • go to Fairdrive., create a pod and get shared pod reference
  • you can install the FairOS software on your computer. [ADD LINK] Once you have done that, you can use the FairOS command-line interface (CLI) to create a new pod. The CLI will generate a unique pod reference for your new pod, which you can then use to access it from any other device that has FairOS installed.

How do I store files and folders in my pod?

To store files and folders in your pod:

  • you can simply drag and drop them into the file manager once you mount your pod in FDA.
  • upload files with Fairdrive
  • or use FairOS CLI to store your files

How do I create a shared pod reference?

To create a shared pod reference, you can simply share the unique pod reference for your pod with others. Anyone who has this pod reference can access your pod and its contents.

In FDA press "Share pod"
image
and a dialog will open:
image

How do I import a shared pod into my FairOS?

To import a shared pod into your FairOS, you can use the FairOS CLI to add the pod reference to your list of pods. Once you have done that, you will be able to access the shared pod and its contents from your own device.

How do I share a pod as a public pod?

In FDA go to Pod->Receive/Import and paste reference.
image
You will be able to see shared pods, under "Shared" tab.

To share a pod as a public pod, you can simply publish the pod reference on a public website or other online platform. Anyone who has the pod reference will be able to access the pod and its contents through the FairOS web interface, using the URL https://fairos-server-url/public/share_pod_reference.

Serving web pages from your pod

FairOS will serve index.html from pod if it is accessed from http through public endpoint.

Simply add the file to the root directory of your pod, and FairOS will automatically serve it to any browser that accesses the pod through the web interface. This means that you can create Single Page Applications (SPAs) using frameworks like React, and host them on FairOS.

FairOS is a file system build on top of Swarm decentralized cloud storage system that allows users to create pods, store files and folders in them, and share those pods with others. Each pod has a unique pod reference that can be used to access it from anywhere. FairOS also allows users to serve index.html files and host static single page applications (SPA).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants