From ce40204250aac534d119438be753b9a5bb1d6c25 Mon Sep 17 00:00:00 2001 From: Jonathan Cobb Date: Sun, 20 Sep 2020 12:38:15 -0400 Subject: [PATCH] update release readme --- README-release.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README-release.md b/README-release.md index 16bde10..2c0d13f 100644 --- a/README-release.md +++ b/README-release.md @@ -35,6 +35,8 @@ We'll walk through each of these steps next. ## Initialize the flex router This step only needs to be done once. After that, bubble-flexrouter will re-use the initialization settings. +On Mac OS and Linux, start by opening a Terminal window. + If you're using Windows, start by opening a Cygwin bash shell. That's what you'll use to run these commands. ### If you have htpasswd installed @@ -66,20 +68,23 @@ run `flex_init.sh` with the `--bcrypt` flag: Start the Bubble app and login. On Linux, run `wg-quick up wg0` to connect. ## Running Flex Router -You'll need to run this as root on Linux/MacOS or Administrator on Windows. +You'll need to run `bubble-flexrouter` as root (on Linux/MacOS) or Administrator (on Windows). #### Set Environment Set environment variables required to run the flex router. -These default should work, where `${HOME}` is the home directory of the user who ran `flex_init.sh`: +These defaults should work, where `${HOME}` is the home directory of the user who ran `flex_init.sh`: export BUBBLE_FR_SSH_KEY=${HOME}/.ssh/flex export BUBBLE_FR_PASS=${HOME}/.bfr_pass export BUBBLE_FR_TOKEN=${HOME}/.bfr_token -On Windows, replace `export` with `set` if you are using the standard Windows `cmd` program. +On Windows, if you are using the standard Windows `cmd` program, +replace `export` with `set` and `${HOME}` with `C:\cygwin64\home\` +where `` is the name of the user who ran `flex_init.sh` #### Run the router +Now that you have your environment variable set, you can run the router: bubble-flexrouter