Getting Started

Learn how to install and run AurisLink in just a few minutes.

Prerequisites

Before installing AurisLink, make sure you have the following installed:

  • Node.js v20.0.0 or higher
  • npm or pnpm for package management
  • Git for cloning the repository

Installation

1. Clone the Repository

git clone https://github.com/ProjectInkDp/aurislink.git
cd aurislink

2. Install Dependencies

npm install

3. Configure AurisLink

Copy the default configuration file and customize it:

cp config.default.ts config.ts

Edit config.ts to configure your audio sources and server settings.

4. Start the Server

npm run dev

Your AurisLink server should now be running on http://localhost:2333

Basic Configuration

Here's a minimal configuration to get you started:

const config = {
  server: {
    host: '0.0.0.0',
    port: 2333,
    password: 'youshallnotpass',
    tls: { enabled: false, cert: '', key: '' },
  },
  logging: {
    level: 'info',
    timestamps: true,
    colors: true,
  },
  sources: {
    soundcloud: { enabled: true, clientId: '' },
    deezer: { enabled: true, arl: '', decryptionKey: '' },
    spotify: { 
      enabled: true, 
      clientId: '', 
      clientSecret: '' 
    },
    jiosaavn: { enabled: true },
  },
};

export default config;

Next Steps

  • 📖 Read the Configuration Guide - Learn how to configure each audio source
  • 🎵 Explore Audio Sources - Understand supported platforms and their setup
  • 🎚️ Discover Filters - Learn about available audio filters and effects
  • 📡 Check the API Reference - Integrate AurisLink with your applications

Troubleshooting

Port Already in Use

If port 2333 is already in use, change it in your config.ts file.

Source Not Working

Make sure you've provided valid credentials for the source in your configuration file.