Skip to content

Commit

Permalink
Update README.md Adding FQDN for all participants
Browse files Browse the repository at this point in the history
  • Loading branch information
nammbash authored Feb 7, 2024
1 parent 16c9972 commit 158fb22
Showing 1 changed file with 24 additions and 8 deletions.
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,6 @@ The Quick Start Guide showcases setting up a federation using the TaskRunner API
5. Start the 2 Collaborators.
```
### Step 0: Prerequisites
#### _Setup FQDN_
```bash
echo $(hostname --all-fqdns | awk '{print tolower($1)}') # Find the right FQDN
```
```bash
export FQDN=<FQDN> # Enter your FQDN here
export no_proxy= localhost,<local machine IP>,<FQDN>
```
#### _Setup Miniconda environment_
```bash
conda create -n fedai python=3.10
Expand All @@ -70,6 +62,14 @@ cd openfl/
python -m pip install .
```
### _Step 1: Setup Aggregator (in the current terminal)_
#### Prerequisite: _Setup FQDN_
```bash
echo $(hostname --all-fqdns | awk '{print tolower($1)}') # Find the right FQDN
```
```bash
export FQDN=<FQDN> # Enter your FQDN here
export no_proxy= localhost,<local machine IP>,<FQDN>
```
#### _Step 1a: Set Aggregator variables._
```bash
export WORKSPACE_TEMPLATE=keras_cnn_mnist # Specify the model to train and associted "FL Plan".
Expand Down Expand Up @@ -99,6 +99,14 @@ fx workspace export # Zip/export Workspace to be able to be imported by collabor
```
### Step 2: Setup Collaborator1 _(in new terminal of same machine)_. _(Tip:Press Ctrl+Alt+T)_
_Note: Steps for new terminal in another machines are similar expect for exchanging files(cp vs scp) between these machines_
#### Prerequisite: _Setup FQDN_
```bash
echo $(hostname --all-fqdns | awk '{print tolower($1)}') # Find the right FQDN
```
```bash
export FQDN=<FQDN> # Enter your FQDN here
export no_proxy= localhost,<local machine IP>,<FQDN>
```
#### _Step 2a: Setup Collaborator1 Variables._
```bash
export COLLAB_NUMBER=1 # need to define the collab number. (1 now, 2 later, etc)
Expand Down Expand Up @@ -150,6 +158,14 @@ cp ${WORKSPACE_PATH_AGGR}/agg_to_col_${COLLAB_NAME}_signed_cert.zip ${WORKSPACE_
fx collaborator certify --import agg_to_col_${COLLAB_NAME}_signed_cert.zip #import signed certificate rfom CA.
```
### Step 3: Setup Collaborator2 _(in new terminal of same machine)_. _(Tip:Press Ctrl+Alt+T)_
#### Prerequisite: _Setup FQDN_
```bash
echo $(hostname --all-fqdns | awk '{print tolower($1)}') # Find the right FQDN
```
```bash
export FQDN=<FQDN> # Enter your FQDN here
export no_proxy= localhost,<local machine IP>,<FQDN>
```
#### _Step 3a same as Step 2a except for COLLAB_NUMBER below._
```bash
export COLLAB_NUMBER=2 # need to define the collab number. (1 now, 2 later, etc)
Expand Down

0 comments on commit 158fb22

Please sign in to comment.