Voice Relay server for CrewLink.
Report Bug
·
Request Feature
This is the relay server for CrewLink, an Among Us proximity voice chat program. I am currently hosting a server at https://crewl.ink/
, but if you want a more reliable option I would suggest to deploy this repository yourself.
Optional environment variables:
PORT
: Specifies the port that the server runs on. Defaults to 443
if HTTPS
is enabled, and 9736
if not.ADDRESS
(REQUIRED): Specifies the server domainNAME
: Specifies the server nameHTTPS
: Enables https. You must place privkey.pem
and fullchain.pem
in your CWD.SSLPATH
: Specifies an alternate path to SSL certificates.To get up and running quickly, you can deploy to Heroku using the button below
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 to connect your client to your server instance.
Run the server with Docker by running the following command:
docker run -d -p 9736:9736 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:
docker run -d -p 8123:9736 ottomated/crewlink-server:latest
To build your own Docker image, do the following:
Clone the repo
git clone https://github.com/ottomated/crewlink-server.git
cd crewlink-server
Run the Docker build command:
docker build -t ottomated/crewlink-server:build .
This is an example of how to list things you need to use the software and how to install them.
npm install yarn -g
git clone https://github.com/ottomated/crewlink-server.git
cd crewlink-server
yarn install
yarn start
Any contributions you make are greatly appreciated.
git checkout -b feature/AmazingFeature
)git commit -m 'Add some AmazingFeature'
)git push origin feature/AmazingFeature
)Distributed under the GNU General Public License v3.0. See LICENSE
for more information.