empede/README.md

36 lines
1.6 KiB
Markdown

# Empede
[![Drone (self-hosted)](https://img.shields.io/drone/build/_/empede?server=https%3A%2F%2Fci.sijman.nl)](https://ci.sijman.nl/_/empede)
[![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/vijfhoek/empede)](https://quay.io/repository/vijfhoek/empede)
[![Crates.io](https://img.shields.io/crates/v/empede)](https://crates.io/crates/empede)
**A web client for MPD.**
![Screenshot](screenshots/screenshot.webp)
## Configuration
Empede is configured using environment variables:
| Name | Default | Description |
| ---------------- | ------------ | --------------------------------- |
| **MPD_HOST** | localhost | MPD server host |
| **MPD_PORT** | 6600 | MPD server port |
| **MPD_PASSWORD** | | MPD server password |
| **EMPEDE_BIND** | 0.0.0.0:8080 | Address for Empede to bind to |
## Running
### Linux
1. Download and extract the [latest release](https://git.sijman.nl/_/empede/releases)
2. Run `./empede` (To specify a host and port, run `MPD_HOST=ip MPD_PORT=6600 ./empede`)
3. Go to http://localhost:8080
### Windows
1. Download and extract the [latest release](https://git.sijman.nl/_/empede/releases)
3. Run `.\empede` in a PowerShell (To specify a host and port, first set the `$env:MPD_HOST` and `$env:MPD_PORT` variables)
3. Go to http://localhost:8080
### Building from source
1. Make sure Rust is installed (https://rustup.rs/)
2. Run `cargo run` (To specify a host and port, run `MPD_HOST=ip MPD_PORT=6600 cargo run`)
3. Go to http://localhost:8080