Adding a koel rock-on

OpenSourceUser · September 24, 2018, 8:13pm

Hello again everybody,
I came across a project called koel (https://koel.phanan.net/) which is something a little bit like self-hosted open source Spotify.
There is no official docker image (https://github.com/phanan/koel), but a few unofficial ones at docker hub. I don’t feel comfortable choosing “the right” (or “best”) container and then try to get it working as a rock-on.
Is anyone here interested in that and would create a json file for koel? I would love to test the extension afterwards =)
Thanks in advance

Flox · September 28, 2018, 6:27pm

Hi @OpenSourceUser,

Thanks for bringing up the subject of Docker images choice. There now is a brief write-up related to the choice of Docker images on the Rockstor documentation. Feel free to have a look and see if it helps you choosing one:
http://rockstor.com/docs/contribute_rockons.html#which-docker-image-should-i-use

You’ll also find more information on how to write your own Rock-on definition file at the link below if you’re interested in giving it a shot.

github.com

rockstor/rockon-registry/blob/master/README.md

# rockon-registry

This repository consists of Rock-on(Docker based apps) configuration profiles
formatted in JSON files. The Rock-On framework of Rockstor parses a well
formatted profiles and provides a generic management and workflow such as
install, uninstall, update, start and stop.

## Can you show me an example?

Look at any <name>.json file in this repository. A simpler example is
[syncthing.json](https://github.com/rockstor/rockon-registry/blob/master/syncthing.json). The structure is intuitive(though cumbersome) and with the help of examples and below description, you can add your own apps with some effort.

## How can I add my own app?

If you are familiar with Docker and know how to run apps by hand, you can create a Rock-on for the same with a little bit of craft. There are three broad steps.

1. Configure the Rock-On service on your Rockstor system. Follow this [doc](http://rockstor.com/docs/docker-based-rock-ons/overview.html).

2. Create your Rock-on profile file, [app].json following the clues in this readme.

This file has been truncated. show original

I’m not a user of this specific app so it may prove difficult for me to pick a good Docker image, but I’ll be willing to try to write a Rock-on definition file if you pick one.
Let us know if you’d like more information!

OpenSourceUser · September 29, 2018, 4:07pm

I think https://hub.docker.com/r/binhex/arch-koel/ is a good choice. There is an official support thread (https://forums.unraid.net/topic/50625-support-binhex-koel/) and binhex maintains quite a lot of docker images.

Looking forward to a rock-on definition file for me to test =) thank you.

Flox · September 29, 2018, 5:12pm

I’ll git it a try @OpenSourceUser. Do you mind creating an issue for this on Github and referring to this forum thread? It’ll help keep track of it.

Flox · September 29, 2018, 6:04pm

Here’s a first draft.
https://github.com/FroggyFlox/rockon-registry/blob/Add_Koel/koel.json

It loads OK on my system but I can’t test the install for now so I’ll you try it out.
As a reminder, @phillxnet wrote a very nice “How-to” try and test Rock-on for verification here:
How to test a Rock-on pull request - #2 by azteech

Enjoy!

OpenSourceUser · October 2, 2018, 1:25pm

Sorry for the late reply. It shows as installed and running but I can’t connect to either port at the moment. Will report back as soon as I got a few minutes to look for the root of the problem.
One small thing though: the info box for the media share mentions “emby”. I guess it was copy pasted and then overlooked in the json file

Edit: patience is the key ^^ It connects just fine now. Guess I could not wait for the services to start - my bad =D

Flox · October 2, 2018, 2:21pm

Glad it works!
Some Rock-ons can take quite a bit of time to boot up, depending on what needs to be done so it can be normal for their webUI to take several minutes. If you’re curious, you can monitor the process at the command line right after clicking the ‘Install’ button by using either docker logs -f koel or journalctl -f.

That is exactly what happened, thanks for catching it!

If the Rockon is behaving like it should, would you mind submitting it to the official repository? You can find instructions in the README, but you can also do the fork, new branch, upload file, submit PR straight from github’s webUI if you prefer. If not, it’s okay, I’ll take care of it some time.

OpenSourceUser · October 2, 2018, 4:30pm

I can’t logon to github at the moment, but I had a chance to test the rock-on and I can confirm it’s working flawlessly. So I’d say you can submit your file as soon as you find the time.
Thanks again for the support

Flox · October 3, 2018, 4:10pm

I just created a corresponding pull request: https://github.com/rockstor/rockon-registry/pull/164

@OpenSourceUser, would you mind confirming that it works there as well (for reference)?

Thanks!