# Basic Configuration

This is the main thing to configure

```yaml
# Web client
client-link: https://localhost:8080
# The self-host web server, useful to host the audio panel and audio files
autoHost: true
autoHostPort: 8080

# Web Socket
clientWebSocketLink: wss://localhost:8081
webSocket:
  webSocketPort: 8081
  webSocketHostName: 0.0.0.0
```

You need to change the localhost by you minecraft server ip, and 2 FREE ports that you can use.\
If you are on a **minecraft host**, check on your admin panel for free ports to use / allocate ports, if you can't find ports that you can use, ask your host. \
If you are on a vps/dedicated you should be able to find 2 free ports.

Configure the file like this

```yaml
# Web client
client-link: https://mcServIP:port1
# The self-host web server, useful to host the audio panel and audio files
autoHost: true
autoHostPort: port1

# Web Socket
clientWebSocketLink: wss://mcServIP:port2
webSocket:
  webSocketPort: port2
  webSocketHostName: 0.0.0.0
```

Example:

```yaml
# Web client
client-link: https://172.253.115.105:30011
# The self-host web server, useful to host the audio panel and audio files
autoHost: true
autoHostPort: 30011

# Web Socket
clientWebSocketLink: wss://172.253.115.105:30012
webSocket:
  webSocketPort: 30012
  webSocketHostName: 0.0.0.0

# Here 172.253.115.105 is the ip of the minecraft server
```

port1 is the port of the webhost

port2 is the port of the websocket

\
Be sure to have free ports for your mcserv, if you are on a vps you shouldn't have problems.\
But when you are on a host using pterodactyl or other software, you need to open the ports/get a list of opened ports

If it doesn't work, be sure to restart your server before testing. \
Try changing ports.\
\
30001 and 30002 generally works well

After setuping /audio

Each link is unique so you need to use the link in game from the connection message or /audio

**Explanation**:\
\- WebSocket is the communication between the mcserv and the web client\
\- WebHost is the autoHost/SelfWebHost system that host the webclient\
So you need 1 free port for the websocket and 1 other free port for the websocket\
You can also host the webclient yourself, see:[Hosting the audio panel yourself & HTML Full custom of the client](/boostedaudio/basics/hosting-the-audio-panel-yourself-and-html-full-custom-of-the-client.md)

If after restart it still don't work you can get help on my discord by opening a ticket

{% embed url="<https://discord.com/invite/PUnTJHThxJ>" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://supermax-8.gitbook.io/boostedaudio/basics/basic-configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
