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 http://54.193.94.35:9736/
, but if you want a more reliable option I would suggest to deploy this repository yourself.
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.
To put it simply, if you named your app "crewlink", you should put crewlink.herokuapp.com:443
or https://crewlink.herokuapp.com
in the "Voice Server" field in the CrewLink client.
(crewlink.herokuapp.com:80
and crewlink.herokuapp.com
are no longer valid since CrewLink client version 1.12, due to changes in order to make all connections through https and not http. If you use any of the previous Voice Servers, the CrewLink client will output the following error: Couldn't fetch latest offsets from server
, even if the offset folder on the server does contain the latest .yml offset file)
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.
- node.js
- yarn
npm install yarn -g
- Clone the repo
git clone https://github.com/ottomated/crewlink-server.git
cd crewlink-server
- Install NPM packages
yarn install
- Compile and run the project
yarn start
- Copy your server's IP and port into CrewLink settings. Make sure everyone in your lobby is using the same server.
Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the GNU General Public License v3.0. See LICENSE
for more information.