{"id":13569367,"url":"https://github.com/michaelmob/docker-funkwhale","last_synced_at":"2025-04-04T05:32:14.472Z","repository":{"id":45219462,"uuid":"164071702","full_name":"michaelmob/docker-funkwhale","owner":"michaelmob","description":"All-in-one funkwhale docker image.","archived":false,"fork":false,"pushed_at":"2021-12-30T15:49:22.000Z","size":89,"stargazers_count":91,"open_issues_count":20,"forks_count":18,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-02T14:06:16.597Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michaelmob.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-04T07:09:41.000Z","updated_at":"2024-06-27T20:26:36.000Z","dependencies_parsed_at":"2022-08-25T19:40:58.081Z","dependency_job_id":null,"html_url":"https://github.com/michaelmob/docker-funkwhale","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelmob%2Fdocker-funkwhale","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelmob%2Fdocker-funkwhale/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelmob%2Fdocker-funkwhale/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelmob%2Fdocker-funkwhale/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaelmob","download_url":"https://codeload.github.com/michaelmob/docker-funkwhale/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223100121,"owners_count":17087387,"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":[],"created_at":"2024-08-01T14:00:39.184Z","updated_at":"2024-11-05T01:32:12.158Z","avatar_url":"https://github.com/michaelmob.png","language":"Dockerfile","funding_links":[],"categories":["Dockerfile","Social Media"],"sub_categories":["Music"],"readme":"# Funkwhale Docker Container\n\n[Funkwhale](https://funkwhale.audio/) is a modern, self-hosted, free and open-source music server.\n\n\n## Usage\n```sh\ndocker run \\\n\t--name=funkwhale \\\n\t-e FUNKWHALE_HOSTNAME=\u003cyourdomain.funkwhale\u003e \\\n\t-e NESTED_PROXY=0 \\\n\t-v \u003c/path/to/data\u003e:/data \\\n\t-v \u003c/path/to/path\u003e:/music:ro \\\n\t-p 3030:80 \\\n\tthetarkus/funkwhale\n```\n\n\n## Parameters\n+ `-e PUID` - Optional user ID for volume ownership.\n+ `-e PGID` - Optional group ID for volume ownership.\n+ `-e FUNKWHALE_HOSTNAME` - Hostname of your Funkwhale instance.\n+ `-e NESTED_PROXY` - Set to 1 when container is behind a reverse proxy.\n+ `-v /data` - Volume to save media files and database.\n+ `-v /music` - Path to your music.\n+ `-p 3030:80` - Access Funkwhale on port 3030.\n\n\n## Instructions\n### Creation\nCreation of the container will take a minute or two. The commands in the sections below will not work until the initialization is complete. For any subsequent runs (assuming you are re-using the `/data` volume), there will be no wait time.\n\n### Create an initial superuser account\nOn the creation of your container, you will need to create an account. Running the following command will prompt you for a username, email, and password for your new account.\n```sh\ndocker exec -it funkwhale manage createsuperuser\n```\n\nall this does is run `/usr/local/bin/manage createsuperuser` on the docker\n\nif you are running on synology docker, in the funkwhale docker window go to Terminal, click the drop-down arrow by create and enter `/bin/sh`\nin the terminal prompt, enter `/usr/local/bin/manage createsuperuser`\n\n\n### Importing Music\nTo import your music, open your Funkwhale instance in your browser and find the libraries page under \"Add content\" and create a library. Click the \"details\" button on your newly created library and get the library ID from the URL bar. It will look similar to the format of: `b8756c0d-839b-461f-b334-583983dc9ead`.\nSet the `LIBRARY_ID` environment variable (or replace it inside of the command) with your library ID, then run the command below.\n```sh\n# For file structures similar to ./Artist/Album/Track.mp3\ndocker exec -it funkwhale manage import_files $LIBRARY_ID \"/music/**/**/*.mp3\" --in-place --async\n```\nFor more information see the [Funkwhale docs on importing music](https://docs.funkwhale.audio/importing-music.html).\n\n### Running behind a proxy\n\nIn more involved deployments, you may have a reverse proxy in front of the container.\n\nIf it is the case, add the `-e NESTED_PROXY=1` flag to the docker run command, or ensure\n`NESTED_PROXY=1` is available in the container environment.\n\n### Build this image\nThis image is built and pushed automatically on `funkwhale/all-in-one`, for all Funkwhale releases and for the development version as well (using the `develop` tag).\n\nIf you want to build it manually, you can run the following:\n```bash\nimage_name='mycustomimage'  # choose a name for the image\nversion='develop'  # replace 'develop' with any tag or branch name\narch='amd64'  # set your cpu architecture\n\n# download Funkwhale front and api artifacts and nginx configuration\n./scripts/download-artifact.sh src/ $version build_front\n./scripts/download-artifact.sh src/ $version build_api\n./scripts/download-nginx-template.sh src/ $version\ndocker build --build-arg $arch -t $image_name:$version .\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelmob%2Fdocker-funkwhale","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelmob%2Fdocker-funkwhale","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelmob%2Fdocker-funkwhale/lists"}