From 8886762ff4856235538904787563004287c71ed1 Mon Sep 17 00:00:00 2001 From: Nathan Parekh Date: Sun, 27 Dec 2020 16:23:18 -0800 Subject: [PATCH 1/3] update readme regarding ADDRESS environment variable --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1927748..6aa5668 100644 --- a/README.md +++ b/README.md @@ -50,24 +50,29 @@ Optional environment variables: ## Deploy to Heroku -To get up and running quickly, you can deploy to Heroku using the button below +To get up and running quickly, you can deploy to Heroku using the button below. [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) -This will deploy an instance of the crewlink-server. You can get the URL of your server by using the app name that you gave when you launched the app on heroku and appending `.herokuapp.com`. You can also find the URL of your server by going to "Settings", scrolling down to "Domains", and removing the `https://` and trailing slash from the url. Using this URL, follow step 4 of the [installation instructions](https://github.com/ottomated/CrewLink-server#manual-installation) to connect your client to your server instance. +You’ll then need to add a config var in the Heroku app settings: + +1. In the management settings for your Heroku app, go to the settings tab. +2. Under the “config vars” section, add a variable called `ADDRESS` and use the URL of your app as the value. You can get the URL of your server by using the app name that you gave when you launched the app on heroku and appending `.herokuapp.com`. You can also find the URL of your server by scrolling down to "Domains", and removing the `https://` and trailing slash from the url. + +Lastly, using the URL, follow step 4 of the [installation instructions](https://github.com/ottomated/CrewLink-server#manual-installation) to connect your client to your server instance. ## Docker Quickstart -Run the server with [Docker](https://docs.docker.com/get-docker/) by running the following command: +Run the server with [Docker](https://docs.docker.com/get-docker/) by running the following command after replacing `example.org` with your server URL: ``` -docker run -d -p 9736:9736 ottomated/crewlink-server:latest +docker run -d -p 9736:9736 -e ADDRESS=“example.org” ottomated/crewlink-server:latest ``` -To change the external port the server uses, change the *first* instance of the port. For example, to use port 8123: +To change the external port the server uses, change the *first* instance of the port and the port in the ADDRESS variable. For example, to use port 8123: ``` -docker run -d -p 8123:9736 ottomated/crewlink-server:latest +docker run -d -p 8123:9736 -e ADDRESS=“example.org:8123” ottomated/crewlink-server:latest ``` ### Building the Docker Image From 60b0cd61bb43a52d010d600d6964cb27137a937c Mon Sep 17 00:00:00 2001 From: Nathan Parekh Date: Sun, 27 Dec 2020 16:27:22 -0800 Subject: [PATCH 2/3] simplify instructions --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6aa5668..75880bb 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,8 @@ To get up and running quickly, you can deploy to Heroku using the button below. You’ll then need to add a config var in the Heroku app settings: -1. In the management settings for your Heroku app, go to the settings tab. -2. Under the “config vars” section, add a variable called `ADDRESS` and use the URL of your app as the value. You can get the URL of your server by using the app name that you gave when you launched the app on heroku and appending `.herokuapp.com`. You can also find the URL of your server by scrolling down to "Domains", and removing the `https://` and trailing slash from the url. +1. In the management settings for your Heroku app, go to the settings tab, then the “config vars” section. +2. Add a variable called `ADDRESS` and use the URL of your app as the value. You can get the URL of your server by using the app name that you gave when you launched the app on heroku and appending `.herokuapp.com`. You can also find the URL of your server by scrolling down to "Domains", and removing the `https://` and trailing slash from the url. Lastly, using the URL, follow step 4 of the [installation instructions](https://github.com/ottomated/CrewLink-server#manual-installation) to connect your client to your server instance. From bbd84680a82864ccdc4f339754b1eae6fac8885d Mon Sep 17 00:00:00 2001 From: Nathan Parekh Date: Sun, 27 Dec 2020 16:35:30 -0800 Subject: [PATCH 3/3] update instructions for manual installation --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 75880bb..53f14af 100644 --- a/README.md +++ b/README.md @@ -112,8 +112,12 @@ cd crewlink-server ```sh yarn install ``` -3. Compile and run the project -```JS +3. Set the ADDRESS variable to your server URL +```sh +ADDRESS=“example.org” +``` +4. Compile and run the project +```sh yarn start ``` 4. Copy your server's IP and port into CrewLink settings. Make sure everyone in your lobby is using the same server.