{"id":18733925,"url":"https://github.com/mgoltzsche/beets-webrouter","last_synced_at":"2025-04-12T18:32:00.249Z","repository":{"id":223220324,"uuid":"759641123","full_name":"mgoltzsche/beets-webrouter","owner":"mgoltzsche","description":"A Beets plugin to serve multiple web apps using a single process on the same port, each under a different path","archived":false,"fork":false,"pushed_at":"2024-09-07T02:37:19.000Z","size":68,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-26T13:21:22.658Z","etag":null,"topics":["beets","beets-plugin","python","web"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mgoltzsche.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-19T03:42:11.000Z","updated_at":"2024-09-07T02:36:01.000Z","dependencies_parsed_at":"2024-05-13T03:27:54.689Z","dependency_job_id":"254bcde1-2dbb-4a15-b191-774adf9b3d23","html_url":"https://github.com/mgoltzsche/beets-webrouter","commit_stats":null,"previous_names":["mgoltzsche/beets-webrouter"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgoltzsche%2Fbeets-webrouter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgoltzsche%2Fbeets-webrouter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgoltzsche%2Fbeets-webrouter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgoltzsche%2Fbeets-webrouter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mgoltzsche","download_url":"https://codeload.github.com/mgoltzsche/beets-webrouter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248570835,"owners_count":21126509,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beets","beets-plugin","python","web"],"created_at":"2024-11-07T15:11:48.513Z","updated_at":"2025-04-12T18:31:59.948Z","avatar_url":"https://github.com/mgoltzsche.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# beets-webrouter\n\nA [beets](https://github.com/beetbox/beets) plugin to serve multiple [Flask](https://github.com/pallets/flask) or [FastAPI](https://github.com/fastapi/fastapi) based beets web apps on the same server/host/port using a single command.\n\nBy running `beet webrouter` you can serve e.g. the beets web UI, a Subsonic API as well as the generated M3U playlists on the same host/port, each under a different path.\n\n## Installation\n\n```sh\npython3 -m pip install beets-webrouter fastapi flask uvicorn\n```\n\nTo install the plugins that are used by the example configuration below, run:\n```sh\npython3 -m pip install beetstream beets-webm3u\n```\n\n## Configuration\n\nEnable the plugin and add a `webrouter` section to your beets `config.yaml` as follows:\n```yaml\nplugins:\n  - webrouter\n  - web\n  - webm3u\n  - beetstream\n  - aura\n  - smartplaylist\n\nwebrouter:\n  host: 0.0.0.0\n  port: 8337\n  routes:\n    /:\n      plugin: web\n    /favicon.ico:\n      plugin: webrouter.favicon\n    /subsonic:\n      plugin: beetstream\n      config:\n        never_transcode: true\n    /aura:\n      plugin: aura\n      blueprint: aura_bp\n    /m3u:\n      plugin: webm3u\n\naura:\n  page_limit: 100\n\nwebm3u:\n  host: 0.0.0.0\n  port: 8339\n  playlist_dir: /data/playlists\n```\n\n## Usage\n\nOnce the `webrouter` plugin is enabled within your beets configuration, you can run it as follows:\n```sh\nbeet webrouter\n```\n\nYou browse the server at [`http://localhost:8337`](http://localhost:8337).\n\n### CLI\n\n```\nUsage: beet webrouter [options]\n```\n\n## Development\n\nRun the unit tests (containerized):\n```sh\nmake test\n```\n\nRun the e2e tests (containerized):\n```sh\nmake test-e2e\n```\n\nTo test your plugin changes manually, you can run a shell within a beets docker container as follows:\n```sh\nmake beets-sh\n```\n\nA temporary beets library is written to `./data`.\nIt can be removed by calling `make clean-data`.\n\nTo just start the server, run:\n```sh\nmake beets-webrouter\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgoltzsche%2Fbeets-webrouter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmgoltzsche%2Fbeets-webrouter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgoltzsche%2Fbeets-webrouter/lists"}