From c5d83881cae81cffb780972269299a9fbbe3fe41 Mon Sep 17 00:00:00 2001 From: Aaron Surty Date: Thu, 14 Jul 2022 12:57:35 -0400 Subject: [PATCH] latest updates for testnet (#115) --- docs/mvp/fotos.md | 10 ++- docs/mvp/fotos/availability.md | 28 +++++++ docs/mvp/fotos/backup.md | 24 ++++++ docs/mvp/fotos/setup.md | 32 ++++++++ docs/mvp/fotos/sharing.md | 26 +++++++ docs/release/testnet-alpha.md | 132 +++++++++++++++++++++++++++++++++ docs/release/testnet_alpha.md | 72 ------------------ 7 files changed, 250 insertions(+), 74 deletions(-) create mode 100644 docs/mvp/fotos/availability.md create mode 100644 docs/mvp/fotos/backup.md create mode 100644 docs/mvp/fotos/setup.md create mode 100644 docs/mvp/fotos/sharing.md create mode 100644 docs/release/testnet-alpha.md delete mode 100644 docs/release/testnet_alpha.md diff --git a/docs/mvp/fotos.md b/docs/mvp/fotos.md index 87b675a..a1b7708 100644 --- a/docs/mvp/fotos.md +++ b/docs/mvp/fotos.md @@ -3,6 +3,12 @@ title: Fotos id: fotos --- -# Fotos +# Fotos Stories -Place holder for some Fotos use cases + * [setup](./fotos/setup) + + * [backup](./fotos/backup) + + * [availability](./fotos/availability) + + * [sharing](./fotos/setup) diff --git a/docs/mvp/fotos/availability.md b/docs/mvp/fotos/availability.md new file mode 100644 index 0000000..4515369 --- /dev/null +++ b/docs/mvp/fotos/availability.md @@ -0,0 +1,28 @@ +--- +title: Fotos Availability +id: availability +--- + +# Fotos Availability + +## Acceptance Criteria + +You uploaded a photo to your Box. + +Your Box goes offline and you are still able to retrieve the photo from a second Box in your pool. + +## Preconditions + +1. You already have a [cluster setup](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. + +3. You already [backed up](./backup) a photo that you would like to share. + +## 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. diff --git a/docs/mvp/fotos/backup.md b/docs/mvp/fotos/backup.md new file mode 100644 index 0000000..8d0d45a --- /dev/null +++ b/docs/mvp/fotos/backup.md @@ -0,0 +1,24 @@ +--- +title: Photo Backup +id: backup +--- + +# Fotos Backup to Box + +## Acceptance Criteria + +You can backup a photo to your Box and retrieve it from the Box at a later date. + +## Preconditions + +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. + +## 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. diff --git a/docs/mvp/fotos/setup.md b/docs/mvp/fotos/setup.md new file mode 100644 index 0000000..8295c05 --- /dev/null +++ b/docs/mvp/fotos/setup.md @@ -0,0 +1,32 @@ +--- +title: Fotos Setup +id: setup +--- + +# Fotos Setup + +## Acceptance Criteria + +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) + +## Steps + +### Connect Fotos to your Box + +1. Find the Box multiaddress from the server logs. + +2. Go to Account -> Boxes and add a new Box copy / pasting the multiaddress from the previous step. + +### Connect Fotos to your wallet + + a. Go to Account -> Connect your wallet + + b. Authorized the Dapp from your wallet. + + c. Tap 'sign your address' when redirected back to Fotos. + + d. Perform the signing request from the wallet. + + diff --git a/docs/mvp/fotos/sharing.md b/docs/mvp/fotos/sharing.md new file mode 100644 index 0000000..200ab4d --- /dev/null +++ b/docs/mvp/fotos/sharing.md @@ -0,0 +1,26 @@ +--- +title: Fotos Sharing +id: sharing +--- + +# Fotos Sharing + +## Story + +I 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. + +3. You already [backed up](./photo_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). + +## Steps + +1. + +2. diff --git a/docs/release/testnet-alpha.md b/docs/release/testnet-alpha.md new file mode 100644 index 0000000..9916534 --- /dev/null +++ b/docs/release/testnet-alpha.md @@ -0,0 +1,132 @@ +--- +title: Protocol Alpha Testnet +id: testnet-alpha +--- + +# Protocol Alpha Testnet + +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. + +## 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. + +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 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. + +## Requirements + + * one Android phone + + * a second Android phone for sharing photos with a friend + + * your own computer that can run [Docker](https://docs.docker.com/get-docker/) + + * Linux is recommended ( macOS also works with a few additional steps) + + * each phone must be on the same network as the computer where the Box app is running + + +## Submitting feedback + +We woud love to know how it went for you! + +Especially if you can not complete any of the steps due to a bug you encountered or because you can not satisfy the above requirements. + +You can send us feedback via Github or as an [email](mailto:testnet@fx.land). + +Here is some boilerplate text you can copy/paste when you are ready to send the feedback. + + +``` +Subject: Protocol alpha testnet + +Feedback Type: [ Bug | Feature Request ] + +Feedback: + +[ I completed all of the steps successfully. This rocked but I have a few suggestions for the next release...] + +OR + +[ I was unable to complete X step(s). The following happened when I tried to complete the step: ...] + +``` + + +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 don't know where the problem exists or don't have a Github account then please send us an [email](mailto:testnet@fx.land) and attach both logs if you are reporting a bug. + +### To output the server logs to a file + +Open a terminal and enter the following in the same directory that you ran docker-compose in the previous steps. + +``` + > docker-compose logs > out.log +``` + +## 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. + +However, because the software we are delivering is fresh off the press and still not properly audited, PLEASE USE WITH CAUTION. + +At this point, we recommend you not upload any highly sensitive media to the Box or use it as a primary backup facility. + +## How to get started + +### 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] + +Note: If on OSX then change the IP address part of the address to the address of your host machine. + +### Fotos Setup + +Download 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 + +Once you have Fotos and the Box environment properly installed you can proceed with the following steps: + +1. See [here](/mvp/fotos/setup) for instructions on setting up Fotos before moving on to anything else. + +2. See [here](/mvp/fotos/backup) for instructions on backing up an image from your device to a Box using Fotos. + +3. See [here](/mvp/fotos/availability) for instructions on verifying that your photos are still available even if one of the Boxes goes does. + +4. See [here](/mvp/fotos/sharing) for instructions on sharing the image with a friend. diff --git a/docs/release/testnet_alpha.md b/docs/release/testnet_alpha.md deleted file mode 100644 index c27a874..0000000 --- a/docs/release/testnet_alpha.md +++ /dev/null @@ -1,72 +0,0 @@ -# Testnet Alpha Pre-release - -Last updated: June 27, 2022 - -## What is it? - -The software we are delivering to you today can give you an idea of how Fotos will backup and store your photos and video to the Box. - -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. - -The 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. - -### Please note - -Fotos is currently only released on Android. If you are running iOS and would like to start testing it out then please let us know at [@TODO include support contact](https://community.fx.land/support) page. - -## What to expect - -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 then go ahead and run 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. - -## Caveat Emptor - -The Functionland testnet alpha release 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. - -At this point, we recommend you not upload any highly sensitive media to the Box or use it as a primary backup facility. - -## How to get started - -### Box Setup - -First, you can follow the instructions [over here](https://github.com/functionland/fula/tree/v0.6.1/apps/cluster) for setting up a local swarm on your host machine with Docker. - -### Fotos Setup - -Once you have verified the Boxes are running and connected from the logs you can install Fotos and configure it to connect to Box0. - -First, download Fotos from the [app center](https://install.appcenter.ms/orgs/fx.-land/apps/photos/distribution_groups/public%20testers/releases/17) and install it. - -Next open Fotos and [@TODO insert info on finding the Box address] - -## Have an idea or feature request? - -We would love to hear back from you on any ideas or things you would like to see in our next release. - -1. Start a discussion in our [Discourse community](https://community.fx.land). - -2. Create an issue on one of the Functionland repos. - - * [Fotos issues](https://github.com/functionland/fotos/issues) - - * [Fula issues](https://github.com/functionland/fula/issues) - - -## Submitting a bug report - -If you encounter a bug or anything strange that is happening with the Box components then please create an issue on the [fula](https://github.com/functionland/fula/issues) repo and include the docker-compose server logs. - -To output the server logs to a file: - -``` - > docker-compose logs > out.log -``` - -Then you can attach the file by dragging it onto the issue when you create it. - -## Get involved with development - -If you are a developer and would like to get involved helping us then we would love to hear from you! The best way to do that is send an email to [@TODO insert dev intake here]