m3uproxy

m3uproxy

m3uproxy is a Go-based HTTP server designed to proxy HLS (HTTP Live Streaming) streams. It provides a convenient way to manage and distribute streaming streams with user management and access control features.

Features

• M3U Playlist Generation: Serve dynamically generated M3U playlists for your streams.
• XMLTV EPG Support: Provide an XMLTV formatted Electronic Program Guide (EPG) for supported streams.
• HLS Stream Proxying: Securely proxy HLS streams via a token-based system.
• User Management: Control access to the M3U playlist and streaming streams.
• Fallback Message: Serve a "stream unavailable" message when necessary.

Endpoints

/channels.m3u (Restricted)

• Description: Returns the M3U playlist with all available streams.
• Access: Restricted to authenticated users.
• Usage: This endpoint should be accessed only after proper authentication. It provides a list of streams in the M3U format.

/epg.xml

• Description: Returns the Electronic Program Guide (EPG) in XMLTV format.
• Access: Public.
• Usage: Useful for clients that support EPGs to fetch the program guide associated with the streams.

/{token}/{streamId}/*

• Description: Proxies the HLS stream for the specified stream.
• Access: Token-based access control.
• Parameters:
  • token: A unique token to authenticate the request.
  • streamId: The identifier of the stream.
• Usage: Used by clients to access the actual HLS stream. Replace {token} and {streamId} with valid values.

/health

• Description: Health check endpoint.
• Access: Public.
• Usage: Used to check the health of the server.

/player

• Description: Serve a simple HTML player to play the streams.
• Access: Public.

Geo-Blocking

m3uproxy supports geo-blocking of streams based on the client's IP address. This feature can be enabled by providing a list of allowed countries in the configuration file.

Installation

To install m3uproxy, you need to have Go installed on your machine.

1. Clone the repository:

   git clone https://github.com/a13labs/m3uproxy.git
   cd m3uproxy
   

2. Build the project:

   go build -o m3uproxy
   

3. Run the server:

   ./m3uproxy server -c config.json
   

User Management

m3uproxy includes basic user management features. Users can be added, removed, or modified through a command-line interface or API.

Adding a User

To add a user, run:

./m3uproxy users add -c <config_file> <username> <password>

Removing a User

To remove a user, run:

./m3uproxy users remove -c <config_file> <username>

Modifying a User

To modify a user's password, run:

./m3uproxy users password -c <config_file> <username> <newpassword>

Usage

Once the server is up and running, you can access the required endpoints as follows:

• M3U Playlist: [Your Server URL]:[port]/channels.m3u
• EPG XML: [Your Server URL]:[port]/epg.xml

Ensure that appropriate access controls are configured to restrict access to sensitive endpoints.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an Issue to discuss any changes or improvements.

License

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

Acknowledgments

• Thanks to the Go community for providing the tools and resources to build this project.
• Special mention to the developers of libraries and tools used in this project.