Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify steps necessary to add music to a library in yunohost installation of funkwhale #132

Closed
lightnin opened this issue Apr 2, 2021 · 2 comments

Comments

@lightnin
Copy link
Contributor

lightnin commented Apr 2, 2021

Funkwhale documentation provides instructions for importing / connecting to external music shares or collections here:
https://docs.funkwhale.audio/admin/importing-music.html#in-place-import

We recommend you symlink all your music directories into /srv/funkwhale/data/music and run the import_files command from that directory. This will make it possible to use multiple music directories, without any additional configuration on the webserver side.

However, this recommended directory does not exist on a Yunohost installation of Funkwhale. Other examples of what to do with docker images / etc. exist on the Funkwhale documentation site but it's not clear if any of those apply to Yunohost installations.

Currently the readme for the funkwhale app states:
Screenshot 2021-04-02 at 17 52 04

However, it's not clear (to this user) what must be done, because executing that command results in an error:
Screenshot 2021-04-02 at 18 11 51

Without that working it seems unlikely the manage.py commands will work for command line import.

Since 1) This will be a common need for many users and 2) The existing funkwhale documentation will not apply because the various paths are different, we should clarify the necessary steps to import music from different locations (like an attached drive or a network share) in the readme.

@Thovi98
Copy link
Member

Thovi98 commented Apr 3, 2021

If I understand well, you want to use your tracks in /home/yunohost.multimedia/share/Music/ in Funkwhale ?
Try to symlink ln -s /home/yunohost.multimedia/share/Music/ /var/www/funkwhale/import

If that works, I will make a PR to include it in the Readme.md.

@lightnin
Copy link
Contributor Author

lightnin commented Apr 3, 2021

This is after a restore of a full system yunohost backup onto a new install / SD card. Where previously I had my music symlinked to a share in /var/www/funkwhale/import, this symlink wasn't restored by the backup (neither was the NFS network mount - but perhaps this is out of the scope of a yunohost backup.) I have since restored the symlink as you suggest, but where previously (at least in 1.0) the library would indicate an import function in library upload below "Import Music from your Server", now it does not. So - not sure what to try next.

I'm assuming the potential steps to put in the readme for users of this app are as follows:

  1. Install via yunohost.
  2. Create symlink to your music library in /var/www/funkwhale/import (This directory didn't exist for me at start, at least after restore.)
  3. Create a new library, select import tab, (then what?)

Normally I would say this level of instruction would be beyond the scope of a yunohost app, and would instead refer users to the Funkwhale documentation. But my argument is that we need to provide a clear set of documented steps for yunohost users because the Funkwhale documentation doesn't accurately apply because the directories / locations don't apply to Yunohost installations. Hence this is an "issue" and not a post on the forum asking for help. Thanks!

lightnin added a commit to lightnin/funkwhale_ynh that referenced this issue Apr 4, 2021
Yunohost installations of Funkwhale use a different path for file imports than those indicated in the Funkwhale documentation.. (/var/www/Funkwhale/import). We should therefore indicate to the admin user what that path is, and steps necessary to use it.   Addresses YunoHost-Apps#132.
@lightnin lightnin closed this as completed Apr 4, 2021
ericgaspar added a commit that referenced this issue Apr 15, 2021
…eadme. (#134)

* Update readme to indicate custom import path 

Yunohost installations of Funkwhale use a different path for file imports than those indicated in the Funkwhale documentation.. (/var/www/Funkwhale/import). We should therefore indicate to the admin user what that path is, and steps necessary to use it.   Addresses #132.

* Fix bash highlighting.

* Update README.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>
yalh76 added a commit that referenced this issue Apr 24, 2021
* Update README.md

* Test bump to 1.0

* Bump to Yunohost 4 (for Debian upgrade)

* Test removal of nonexistent scripts

* Correct Typo

* Update README.md

* Fix linter warnings

* Fix linter

* Fix linter warnings

* Cleaning up

* Update README.md

* Update to 1.0.1 (#119)

* Update to 1.0.1

* Set new permissions

* Add French Readme

* Readme update

* Update README.md

* Update README.md

* Update README_fr.md

* Update README.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Update README_fr.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Update README.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Update README_fr.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Finding an available port

* Uprade to 1.1 and fixes Twisted by retrograding it (#129)

* Fix linter warning : no need to use $is_public

* Clarify custom paths needed to import collections of music files in Readme. (#134)

* Update readme to indicate custom import path 

Yunohost installations of Funkwhale use a different path for file imports than those indicated in the Funkwhale documentation.. (/var/www/Funkwhale/import). We should therefore indicate to the admin user what that path is, and steps necessary to use it.   Addresses #132.

* Fix bash highlighting.

* Update README.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Apply Example_ynh (#131)

* Testing (#130)

* Uprade to 1.1 and fixes Twisted by retrograding it (#129)

* Apply example_ynh

Fix #15

* Fix services

* Fix several merging

* Stick to official install process

* fix path_transversal

* Using option '--log_type systemd' with 'yunohost service add' is not relevant anymore

* Try to fix package_check

* Fix package_check test

* Update check_process

* Trying to fix package_check

* Update env.prod

* remove sleep

* Better service name

* missing datadir

* line 111: upgrade_type: unbound variable

* Implement --is_big

* Fix stopping service from previous version

* Fix upgrade

* Fix upgrade

* Apply example_ynh

* Apply example_ynh

* Fix rights

* Update api.src

* Update env.prod

* Update front.src

* Update manifest.json

* Update README.md

* Update README_fr.md

* Fix chmod

* Fix rights

Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>
Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Update conf/nginx.conf

Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>

* Update conf/nginx.conf

Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>

* fix

* Fix rights for datadir from previous version

* Update upgrade

* Fix recursive chmod

* Fix import link

* Update README_fr.md

Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>
Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>
Co-authored-by: Ciarán Ainsworth <cda@rootkey.co.uk>
Co-authored-by: Ciarán Ainsworth <ciaranainsworth@posteo.net>
Co-authored-by: ericgaspar <junk.eg@free.fr>
Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>
Co-authored-by: Amos Blanton <lightnin@users.noreply.github.com>
yalh76 added a commit that referenced this issue May 19, 2021
* Upgrade to 1.1.1 (#138)

* Update README.md

* Test bump to 1.0

* Bump to Yunohost 4 (for Debian upgrade)

* Test removal of nonexistent scripts

* Correct Typo

* Update README.md

* Fix linter warnings

* Fix linter

* Fix linter warnings

* Cleaning up

* Update README.md

* Update to 1.0.1 (#119)

* Update to 1.0.1

* Set new permissions

* Add French Readme

* Readme update

* Update README.md

* Update README.md

* Update README_fr.md

* Update README.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Update README_fr.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Update README.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Update README_fr.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Finding an available port

* Uprade to 1.1 and fixes Twisted by retrograding it (#129)

* Fix linter warning : no need to use $is_public

* Clarify custom paths needed to import collections of music files in Readme. (#134)

* Update readme to indicate custom import path 

Yunohost installations of Funkwhale use a different path for file imports than those indicated in the Funkwhale documentation.. (/var/www/Funkwhale/import). We should therefore indicate to the admin user what that path is, and steps necessary to use it.   Addresses #132.

* Fix bash highlighting.

* Update README.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Apply Example_ynh (#131)

* Testing (#130)

* Uprade to 1.1 and fixes Twisted by retrograding it (#129)

* Apply example_ynh

Fix #15

* Fix services

* Fix several merging

* Stick to official install process

* fix path_transversal

* Using option '--log_type systemd' with 'yunohost service add' is not relevant anymore

* Try to fix package_check

* Fix package_check test

* Update check_process

* Trying to fix package_check

* Update env.prod

* remove sleep

* Better service name

* missing datadir

* line 111: upgrade_type: unbound variable

* Implement --is_big

* Fix stopping service from previous version

* Fix upgrade

* Fix upgrade

* Apply example_ynh

* Apply example_ynh

* Fix rights

* Update api.src

* Update env.prod

* Update front.src

* Update manifest.json

* Update README.md

* Update README_fr.md

* Fix chmod

* Fix rights

Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>
Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

* Update conf/nginx.conf

Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>

* Update conf/nginx.conf

Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>

* fix

* Fix rights for datadir from previous version

* Update upgrade

* Fix recursive chmod

* Fix import link

* Update README_fr.md

Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>
Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>
Co-authored-by: Ciarán Ainsworth <cda@rootkey.co.uk>
Co-authored-by: Ciarán Ainsworth <ciaranainsworth@posteo.net>
Co-authored-by: ericgaspar <junk.eg@free.fr>
Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>
Co-authored-by: Amos Blanton <lightnin@users.noreply.github.com>

* remove others_var

* no more needed

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>
Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>
Co-authored-by: Ciarán Ainsworth <cda@rootkey.co.uk>
Co-authored-by: Ciarán Ainsworth <ciaranainsworth@posteo.net>
Co-authored-by: ericgaspar <junk.eg@free.fr>
Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com>
Co-authored-by: Amos Blanton <lightnin@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants