/ts3proxy-1

A simple application for creating teamspeak 3 proxys like ts3.cloud.

Primary LanguageJavaScriptMIT LicenseMIT

ts3Proxy Logo

TeamSpeak 3 Proxy

Discord

A simple application for creating teamspeak 3 proxys like ts3.cloud.

Working live demo available at: https://ts3proxy.unlimitedbytes.ovh/

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

  • NodeJS
  • NPM

Installing

Create a new user:

$ sudo adduser ts3proxy

Navigate to the home directory of the new user:

$ sudo cd /home/ts3proxy

Copy the project to your local system

$ sudo git clone https://github.com/UnlimitedBytes/ts3proxy.git

Navigate into the project folder

$ sudo cd ts3proxy

Change the ipaddress in the config.json file to your servers ip address:

{
	"ipaddress": "1.1.1.1",
	"ports": "..."
}

Install the required dependencies

$ sudo npm install

Give the new user the ownership of the applications folder and all files in it:

$ sudo chown -R ts3proxy: .

At least switch the user and start the application by running

$ sudo su ts3proxy
$ npm start

Now you can open your webbrowser and go to: http://<your_servers_ip>:1337

Congratulations now you can create teamspeak 3 proxys.

Deployment

Additional notes about how to deploy this on a live system.

I just wannted to recommend pm2 for live deployment.

Built With

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.