50 lines
1.1 KiB
Markdown
50 lines
1.1 KiB
Markdown
# Media Server - Development Guide
|
|
|
|
## Overview
|
|
|
|
Standalone REST API server (FastAPI) for controlling system-wide media playback on Windows, Linux, macOS, and Android.
|
|
|
|
## Running the Server
|
|
|
|
### Manual Start
|
|
|
|
```bash
|
|
python -m media_server.main
|
|
```
|
|
|
|
### Auto-Start on Boot (Windows Task Scheduler)
|
|
|
|
Run in **Administrator PowerShell** from the media-server directory:
|
|
|
|
```powershell
|
|
.\media_server\service\install_task_windows.ps1
|
|
```
|
|
|
|
To remove the scheduled task:
|
|
|
|
```powershell
|
|
Unregister-ScheduledTask -TaskName "MediaServer" -Confirm:$false
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Copy `config.example.yaml` to `config.yaml` and customize.
|
|
|
|
The API token is generated on first run and displayed in the console output.
|
|
|
|
Default port: `8765`
|
|
|
|
## Versioning
|
|
|
|
Version is tracked in two files that must be kept in sync:
|
|
|
|
- `pyproject.toml` - `[project].version`
|
|
- `media_server/__init__.py` - `__version__`
|
|
|
|
When releasing a new version, update both files with the same version string.
|
|
|
|
## Git Rules
|
|
|
|
- Always ask for user approval before committing changes to git.
|
|
- When pushing, always push to all remotes: `git push origin master && git push github master`
|