Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shimberger/gohls
A server that exposes a directory for video streaming via web interface
https://github.com/shimberger/gohls
ffmpeg golang hacktoberfest hls react video-stream videojs
Last synced: about 2 months ago
JSON representation
A server that exposes a directory for video streaming via web interface
- Host: GitHub
- URL: https://github.com/shimberger/gohls
- Owner: shimberger
- License: other
- Created: 2015-07-19T14:51:17.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-24T08:03:08.000Z (over 1 year ago)
- Last Synced: 2024-06-20T03:34:52.132Z (3 months ago)
- Topics: ffmpeg, golang, hacktoberfest, hls, react, video-stream, videojs
- Language: Go
- Homepage: https://shimberger.github.io/gohls/
- Size: 3.25 MB
- Stars: 557
- Watchers: 25
- Forks: 87
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-video - shimberger/gohls - A server that exposes a directory for video streaming via web interface - shimberger/gohls (HLS / Talks Presentations Podcasts)
README
# Golang HLS Streamer
[](https://github.com/shimberger/gohls/actions/workflows/build_and_release_snapshot.yml)
[](https://godoc.org/github.com/shimberger/gohls)
Simple server that exposes a directory for video streaming via HTTP Live Streaming (HLS). Uses ffmpeg for transcoding.
*This project is cobbled together from all kinds of code I had lying around so it's pretty crappy all around. It also has some serious shortcomings.*
## Running it
*Important*: You need the ffmpeg and ffprobe binaries in your PATH. The server will not start without them. You can find builds most operating systems at [https://ffmpeg.org/download.html](https://ffmpeg.org/download.html).
### 1. Download the binary for your operating system
You can find the latest release on the releases page [https://github.com/shimberger/gohls/releases](https://github.com/shimberger/gohls/releases) or just download a current snapshot:
- [Windows (64 bit)](https://s3.amazonaws.com/gohls/gohls-windows-amd64-snapshot.tar.gz)
- [Linux (64 bit)](https://s3.amazonaws.com/gohls/gohls-linux-amd64-snapshot.tar.gz)
- [Linux (32 bit)](https://s3.amazonaws.com/gohls/gohls-linux-386-snapshot.tar.gz)
- [Linux (Arm 64 bit)](https://s3.amazonaws.com/gohls/gohls-linux-arm64-snapshot.tar.gz)
- [macOS (64 bit)](https://s3.amazonaws.com/gohls/gohls-osx-snapshot.tar.gz)
- [macOS (Arm (M1) 64 bit)](https://s3.amazonaws.com/gohls/gohls-osx-arm64-snapshot.tar.gz)
### 2. Create a configuration file
The configuration is stored in JSON format. Just call the file `gohls-config.json` or whatever you like. The format is as follows:
```
{
"folders": [
{
"path": "~/Videos",
"title": "My Videos"
},
{
"path": "~/Downloads",
"title": "My Downloads"
}
]
}
```
This will configure which directories on your system will be made available for streaming. See the screenshot for details:
### 3. Run the server
Execute the command `gohls serve -config ` e.g. `gohls serve -config gohls-config.json` to serve the videos specified by the config file. To make the server listen on another port or address just use the `serve` command with `--listen` like so (the example uses port 7000 on all interfaces): `gohls serve --listen :7000 -config `
### 4. Open a web browser
Visit the URL [http://127.0.0.1:8080](http://127.0.0.1:8080) to access the web interface.
## Contributing
### Requirements
- [go installed](https://golang.org/dl/)
- [npm installed](https://nodejs.org/en/) *(NPM is part of Node.js)*
- bash
### Initial setup
1. Clone the repository `[email protected]:shimberger/gohls.git`
2. Build frontend `cd ui/ && npm install && npm run build && cd ..`
### Running server
To then run the development server execute: `./scripts/run.sh serve`
## License
See [LICENSE.txt](https://github.com/shimberger/gohls/blob/master/LICENSE.txt)