diff --git a/README.md b/README.md index 455b9e17..aa5f6928 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,25 @@ # Quickstart User Installation -## install uv +## SyftBox 1 liner + +curl -LsSf https://syftbox.openmined.org/install.sh | sh -s -- run + +## Manual install + +### install uv curl -LsSf https://astral.sh/uv/install.sh | sh -## create a virtualenv somewhere +### create a virtualenv somewhere uv venv .venv -## Install Syftbox +### Install Syftbox uv pip install -U syftbox -## run the client +### run the client uv run syftbox client @@ -66,13 +72,17 @@ uv run syftbox/client/client.py ### Run Client ``` -syftbox client --config_path=./config.json --sync_folder=~/Desktop/SyftBox --email=your@email.org --port=8082 --server=http://syftbox.openmined.org:8080 +syftbox client --config_path=./config.json --sync_folder=~/Desktop/SyftBox --email=your@email.org --port=8082 --server=https://syftbox.openmined.org ``` +### Staging Server + +If you have issues or want to use a bleeding edge server try --server=https://syftboxstage.openmined.org + ### Deploy This builds the latest source to a wheel and deploys and restarts the server: -http://syftbox.openmined.org:8080 +https://syftbox.openmined.org ``` ./scripts/deploy.sh diff --git a/scripts/live_andrew.sh b/scripts/live_andrew.sh index cd8b1ea4..6370bb5b 100755 --- a/scripts/live_andrew.sh +++ b/scripts/live_andrew.sh @@ -1,2 +1,2 @@ #!/bin/bash -uv run syftbox/client/client.py --config_path=./users/live_andrew.json --sync_folder=./users/live_andrew --email=andrew@openmined.org --port=8082 --server=http://syftbox.openmined.org:8080 +uv run syftbox/client/client.py --config_path=./users/live_andrew.json --sync_folder=./users/live_andrew --email=andrew@openmined.org --port=8082 --server=https://syftbox.openmined.org diff --git a/scripts/live_madhava.sh b/scripts/live_madhava.sh index 36a18a13..57b17d7a 100755 --- a/scripts/live_madhava.sh +++ b/scripts/live_madhava.sh @@ -1,2 +1,2 @@ #!/bin/bash -uv run syftbox/client/client.py --config_path=./users/live_madhava.json --sync_folder=./users/live_madhava --email=madhava@openmined.org --port=8081 --server=http://syftbox.openmined.org:8080 +uv run syftbox/client/client.py --config_path=./users/live_madhava.json --sync_folder=./users/live_madhava --email=madhava@openmined.org --port=8081 --server=https://syftbox.openmined.org diff --git a/syftbox/client/client.py b/syftbox/client/client.py index 10523ee4..e8223848 100644 --- a/syftbox/client/client.py +++ b/syftbox/client/client.py @@ -132,6 +132,10 @@ def load_or_create_config(args) -> ClientConfig: if email_token: client_config.email_token = email_token + # Migrate Old Server URL to HTTPS + if client_config.server_url == "http://20.168.10.234:8080": + client_config.server_url = "https://syftbox.openmined.org" + client_config.save(args.config_path) return client_config @@ -293,7 +297,7 @@ def parse_args(): parser.add_argument( "--server", type=str, - default="http://20.168.10.234:8080", + default="https://syftbox.openmined.org", help="Server", ) return parser.parse_args()