Skip to content

Commit

Permalink
small wording fixes for testnet writeup (functionland#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
@gitaaron
gitaaron committed Jul 15, 2022
1 parent b8814c9 commit 9c39548
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 56 deletions.
8 changes: 5 additions & 3 deletions docs/mvp/fotos/availability.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,18 @@ Your Box goes offline and you are still able to retrieve the photo from a second

## Preconditions

1. You already have a [cluster setup](https://github.com/functionland/fula/tree/main/apps/cluster).
1. You have already [setup a cluster](https://github.com/functionland/fula/tree/main/apps/cluster).

2. You already [setup](./setup) Fotos with your own wallet account and connected it to your Box.
2. You have already [setup Fotos](./setup) with your own wallet account and connected it to your Box.

3. You already [backed up](./backup) a photo that you would like to share.

## Steps

[See here](https://drive.google.com/file/d/1BxYo3Enb_6f4cgcMazsAPskfcNQMCowW/view?usp=sharing) for a video demonstrating the following steps.

1. Delete the photo from your device by long pressing the photo and selecting the 'delete' icon.

2. Remove the first Box from your list and add the second using the multiaddress from the server logs of the second Box.

3. Verify that the second Box is in fact storing the image and that you are able to retrieve it by deleting the image from your device and tapping on the placeholder thumbnail that appears in its place.
3. Verify that the second Box is in fact storing the image and that you are able to retrieve it by tapping on the placeholder thumbnail that appears in the deleted image's place.
8 changes: 5 additions & 3 deletions docs/mvp/fotos/backup.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Photo Backup
title: Fotos Backup to Box
id: backup
---

Expand All @@ -13,12 +13,14 @@ You can backup a photo to your Box and retrieve it from the Box at a later date.

1. You already have a Box running.

2. You have already [setup](./setup) Fotos with your own wallet account and connected it to your box.
2. You have already [setup Fotos](./setup) with your own wallet account and connected it to your Box.

## Steps

[See here](https://drive.google.com/file/d/1BfwDusYmMmLQ7ksmMcXTMUSQv7dUmwN4/view?usp=sharing) for a video demonstrating the following steps.

1. Tap on a photo to enter browse mode and tap the 'upload to cloud' icon in the top right.

2. After the image has uploaded succesfully you should see a 'cloud with a checkbox' icon and a 'share' icon in browse mode for the image.

3. You can verify that the Box is in fact storing the image for you and that you are able to retrieve it by deleting the image from your device and tapping on the placeholder thumbnail that appears in its place.
3. You can verify that the Box is in fact storing the image for you and that you are able to retrieve it by deleting the image from your device and tapping on the placeholder thumbnail that appears in its place to download it.
33 changes: 25 additions & 8 deletions docs/mvp/fotos/setup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,41 @@ id: setup

You setup Fotos with your wallet account and connect it to your Box.

Once setup correctly you are able to perform all other [Fotos stories](/mvp/fotos)
Once setup correctly you are able to perform all other [Fotos stories](/mvp/fotos).

## Preconditions

1. You have already downloaded and installed Fotos.

2. You already have a Box running and have acquired the Box's multiaddress from the server logs that is reachable from your phone.

## Steps

### Connect Fotos to your wallet

[See here](https://drive.google.com/file/d/1B1TJxssjRfQfpbDeMliPQj-g6ONmv1zY/view?usp=sharing) for a video demonstrating the following steps.

1. Go to Account -> Connect your wallet

2. Authorize the Dapp from your wallet.

3. Tap 'sign your address' when redirected back to Fotos.

4. Perform the signing request from the wallet.

### Connect Fotos to your Box

1. Find the Box multiaddress from the server logs.
[See here](https://drive.google.com/file/d/1BeIia_QthpVlhq9x_fYXaZdpp6QPdCVq/view?usp=sharing) for a video demonstrating the following steps.

2. Go to Account -> Boxes and add a new Box copy / pasting the multiaddress from the previous step.

### Connect Fotos to your wallet
1. Copy the Box's multiaddress to your clipboard.

a. Go to Account -> Connect your wallet
2. Go to Account -> Boxes.

b. Authorized the Dapp from your wallet.
3. Add a new Box.

c. Tap 'sign your address' when redirected back to Fotos.
a ) Give the Box a name for identification purposes (can be anything).

d. Perform the signing request from the wallet.
b ) Paste the Box's multiaddress .


32 changes: 27 additions & 5 deletions docs/mvp/fotos/sharing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,42 @@ id: sharing

## Story

I can share a photo with a friend.
You can share a photo with a friend.

## Preconditions

1. You already have a running Box.

2. You have already [setup](./setup) Fotos with your own wallet account and connected it to your box.
2. You have already [setup Fotos](./setup) with your own wallet account and connected it to your Box.

3. You already [backed up](./backup) a photo that you would like to share.

4. You have already [setup](./setup) Fotos on a second device you would like to share the photo with (same Box different wallet).
4. You have already [setup](./setup) Fotos on a second device you would like to share the photo with (same Box different wallet). It must be connected to a Box that is a member of the pool where the photo was uploaded.

## Steps

1.
### Have your friend send you there DID

2.
[See here](https://drive.google.com/file/d/1BszC5wGTWHuMsGUlCvp9tvPxKFbWmz5A/view?usp=sharing) for a video demonstrating the following steps.

1. Tell them to go to 'Account' -> 'share' icon.

2. Tell them to send their DID to you in a secure/private channel (eg/ copy to their clipboard and send it to you as an email) back to your friend.

### Send the share link to your friend

[See here](https://drive.google.com/file/d/1Btz-8EMqNHZW3OiEl3ioMDidcuIvztAa/view?usp=sharing) for a video demonstrating the following steps.

1. Tap on the photo to share.

2. Tap the 'share' icon.

3. Paste the DID that your friend sent you.

4. You should see a 'shared' message stating the asset was added to a shared collection. Tap 'yes' to get the sharing link and send it over a secure/private channel.

### You friend can view the shared photo

TODO : create video for this step

1. When your friend taps on the link it should open Fotos on their phone and display the image you shared with them.
52 changes: 15 additions & 37 deletions docs/release/testnet-alpha.md
View file
Original file line number Diff line number Diff line change
@@ -1,35 +1,25 @@
---
title: Protocol Alpha Testnet
title: Protocol Testnet Alpha Prerelease
id: testnet-alpha
---

# Protocol Alpha Testnet
# Protocol Testnet Alpha Prerelease

Last updated: July 11, 2022

## What is it?

The protocol testnet alpha pre-release includes the Fotos mobile application and some of the Box components that will be pre-installed on Box customer's raspberry Pis when they are shipped.

## Purpose

1. To give backers an update on our progress by giving them the ability to test things out for themselves.

2. Help us find errors and edge cases (especially long lived) before we launch.

3. Gather feedback so we can ensure we are delivering on what is important when we ship.

4. Build community / rapport with people that share similar values as ourselves.
The protocol testnet alpha prerelease includes the Fotos mobile application and some of the Box components that will be pre-installed on Box customer's raspberry Pis when they are shipped.

## What to expect

The software we are delivering to you today can give you an idea of how the Fotos mobile app will backup and store your photos and video to the Box.
The software we are delivering to you today can give you an idea of how the Fotos mobile app will backup and store your photos to the Box.

Once you have everything setup you should have two Boxes talking to each other running on your host machine.

You should be able to upload your media using Fotos from your mobile phone to one of the Boxes encrypted with a key from your own wallet.

You can use the web gallery sample app to verify that the photos are in fact synced to both Boxes and that you are able to view them on a different device.
You can verify that the photos are in fact synced to both Boxes and that you are able to view them on a different device.

You can also get an idea of how a decentralized identity might be generated from yours and your friends wallets in order to enable sharing of photos with each other.

Expand Down Expand Up @@ -58,7 +48,7 @@ Here is some boilerplate text you can copy/paste when you are ready to send the


```
Subject: Protocol alpha testnet
Subject: Protocol testnet alpha
Feedback Type: [ Bug | Feature Request ]
Expand All @@ -73,11 +63,11 @@ OR
```


If you believe the issue is happening in the backend then you can create an issue on the [fula](https://github.com/functionland/fula/issues) repo and include the docker-compose server logs.
If you believe the issue is happening in the backend then you can create an issue on the [Fula](https://github.com/functionland/fula/issues) repo and include the docker-compose server logs.

If you believe the issue is happening in the Fotos mobile client then you can create an issue on the [fotos](https://github.com/functionland/fotos/issues) repo and describe what is going wrong.
If you believe the issue is happening in the Fotos mobile client then you can create an issue on the [Fotos](https://github.com/functionland/fotos/issues) repo and describe what is going wrong.

If you don't know where the problem exists or don't have a Github account then please send us an [email](mailto:[email protected]) and attach both logs if you are reporting a bug.
If you don't know where the problem exists or don't have a Github account then please send us an [email](mailto:[email protected]) and attach the server logs if you are reporting a bug.

### To output the server logs to a file

Expand All @@ -89,7 +79,7 @@ Open a terminal and enter the following in the same directory that you ran docke

## Beware of Risks

The Functionland protocol alpha testnet release includes client side encryption as a first layer of security to help prevent others from gaining access to your photos and video.
The Functionland protocol testnet alpha prerelease includes client side encryption as a first layer of security to help prevent others from gaining access to your photos and video.

However, because the software we are delivering is fresh off the press and still not properly audited, PLEASE USE WITH CAUTION.

Expand All @@ -99,27 +89,15 @@ At this point, we recommend you not upload any highly sensitive media to the Box

### Box Setup

First, you can follow the instructions [over here](https://github.com/functionland/fula/blob/main/apps/cluster/README.md) for setting up a local swarm on your host machine with Docker.

To connect Fotos to your Box, you will need to find the multiaddress from the logs. From a shell where docker-compose is running use the following command to see logs for Box0 -

```
> docker-compose logs -f box0
```

[@TODO insert screenshot of what box0 log looks like with multiaddr highlighted]

In order to perform the verify availability step ( 3 ) you will need the multiaddr of the second Box. You can see the logs similarly to how you did it for box1.

[@TODO insert screenshot of what box1 log looks like with multiaddr highlighted]
First, you can follow the instructions [over here](https://github.com/functionland/fula/blob/main/apps/cluster/README.md) for setting up a local pool on your host machine with Docker.

Note: If on OSX then change the IP address part of the address to the address of your host machine.
Make sure you read through all steps carefully to ensure your Box environment is up and running properly. In particular, pay close attention to the instructions on [getting the Box multiaddress / Peer ID](https://github.com/functionland/fula/blob/main/apps/cluster/README.md#getting-box-multiaddress--peer-id) as you will need that for setting up Fotos.

### Fotos Setup
### Fotos Installation

Download latest release of Fotos from the [app center](https://install.appcenter.ms/orgs/fx.-land/apps/photos/releases) and install it.
Download the latest release of Fotos from the [app center](https://install.appcenter.ms/orgs/fx.-land/apps/photos/releases) and install it.

## Protocol Alpha Testnet Steps
### Testing Steps

Once you have Fotos and the Box environment properly installed you can proceed with the following steps:

Expand Down

0 comments on commit 9c39548

Please sign in to comment.