_
/
empede
1
0
Fork 0
Code Issues Releases 18 Activity
empede/README.md

35 lines
1.4 KiB
Markdown
Raw Normal View History

Add README
2023-04-27 14:07:48 +00:00
# Empede
Add a couple of shields
2023-05-01 23:45:40 +00:00
![Drone (self-hosted)](https://img.shields.io/drone/build/_/empede?server=https%3A%2F%2Fci.sijman.nl)
![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/vijfhoek/empede)
![Crates.io](https://img.shields.io/crates/v/empede)
Add README
2023-04-27 14:07:48 +00:00
**A web client for MPD.**
![Screenshot](screenshots/screenshot.webp)
Allow for setting the bind address
2023-04-27 22:33:13 +00:00
## Configuration
Empede is configured using environment variables:
Update README for Windows
2023-04-28 10:49:07 +00:00
| Name | Default | Description |
| --------------- | ------------ | --------------------------------- |
| **MPD_HOST** | localhost | MPD server host |
| **MPD_PORT** | 6600 | MPD server port |
| **EMPEDE_BIND** | 0.0.0.0:8080 | Address for Empede to bind to |
Allow for setting the bind address
2023-04-27 22:33:13 +00:00
Add README
2023-04-27 14:07:48 +00:00
## Running
Add Linux binary to readme
2023-04-27 14:37:54 +00:00
### Linux
Update README
2023-04-27 14:40:41 +00:00
1. Download and extract the [latest release](https://git.sijman.nl/_/empede/releases)
Add Linux binary to readme
2023-04-27 14:37:54 +00:00
2. Run `./empede` (To specify a host and port, run `MPD_HOST=ip MPD_PORT=6600 ./empede`)
3. Go to http://localhost:8080
Update README for Windows
2023-04-28 10:49:07 +00:00
### 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
Add README
2023-04-27 14:07:48 +00:00
### 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