8000 Update instructions given the new ADDRESS requirement by nathanparekh · Pull Request #118 · ottomated/CrewLink-server · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update instructions given the new ADDRESS requirement #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update instructions given the new ADDRESS requirement #118

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8886762
update readme regarding ADDRESS environment variable
nathanparekh Dec 28, 2020
60b0cd6
simplify instructions
nathanparekh Dec 28, 2020
bbd8468
update instructions for manual installation
nathanparekh Dec 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, 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.

## 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
Expand Down Expand Up @@ -107,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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where do you do this? What file? I am assuming .env but not everyone will know about such files

Copy link
Author
@nathanparekh nathanparekh Dec 28, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case I was supposing you'd set it as a shell variable (see the example snippet, though I suppose that code snippet wouldn't work on Windows)... but maybe a .env file would be a better idea as it'd persist?

```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.
Expand Down
0