YouPHPTube (((New Appliance))

This appliance is about 95% complete. Code not posted yet, but soon. I will need a bit of help on this one if there is someone in the community with the requisite knowledge. Only thing left to do is script the initial setup. I reviewed some of the other similar appliances (wordpress, e107), but I am not experienced with using curl in cons.d/main to configure the appliance.

[JedMeister]

You my friend are a bloody legend! Another great looking appliance! You must be getting sick of my apologies about how long things are taking...

We're super close to a v15.0RC Core release, the thing that's currently blocking us now, is getting our pacakge to build reproducibly in our package building infrastructure.

---

WRT to using a curl install, TBH, it's been ages since I've done a new one.

IIRC I used to use Firefox with the LiveHTTPHeaders addon. You then go through the in browser installation as per usual and watch the traffic via the addon. You can then replay it via curl commands.

I also just asked one of our devs and he said that it's been a little while since he's done a new one too but said that the network tab in Firefox developer tools should probably be enough these days.

Chrome has something similar, although I do recall that wasn't as good as LiveHTTPHeaders.

Have a bit of a play and see how you go. I don't want to pull any of the devs off v15.0 work ATM, but if things go to plan over the next few weeks (as they do on the odd occasion...) then perhaps one of them may be able to give you a hand?

I will give LiveHTTPHeaders a go and try to do the replay via curl. Wasn't asking for anyone to come off v15.0 as I am anxiously awaiting it also to ensure I make the requisite changes to the appliances I have already submitted for the transition to stretch. Thanks for the heads up on LiveHTTPHeaders.

Have not forgotten about this one. Everything is complete to the point where final config files need to be written. I have come up at a loss using LiveHTTPHeaders, but it looks like I can use the database creation script, write the config file via conf.d, and script the admin user creation in the database.

Do not have a good ETA when I will be done right now. Will report back as I make progress.

[JedMeister]

I have come up at a loss using LiveHTTPHeaders

Hmm, that sucks.

I can use the database creation script, write the config file via conf.d, and script the admin user creation in the database.

A DB creation script within the YouPHPTube code you mean? Or something else?

If you can leverage something within the code (within a conf.d script) that is easy to read, then go for it. Please don't include SQL dumps though. They're notoriously hard to read and maintain.

Adding config file via conf.d script (or even overlay) and scripting admin user creation is fine. 😄

Oops forgot ETA... There isn't any ETA currently. I hope to publish the first batch ASAP (it was going to be this week, but I've run out of week...). But there will be further batches. And even after we've released all v15.0, then adding a new v15.0 appliance should be easy.

The code for YouPHPTube includes a database generation script it is not a dump.

Link to database creation script in YouPHPTube code for reference.
https://github.com/DanielnetoDotCom/YouPHPTube/blob/master/install/database.sql

I will not use any dumps. Following the php in the install it basically does 3 things during install. It executes the database.sql, creates a config file in /var/www/html/$YouPHPTubeDirectory/videos and adds the admin user and email to the database.

I think I can accomplish this relatively easily by scripting database creation into conf.d, creation of admin user in conf.d, and writing the config file in conf.d or including in overlay.

Essentially leaving three inithooks for final config. First init would require user to enter web address for the youphptube server and update youphptube config file. Second hook would update the database password for youphptube database user and update config file to match, third would update the admin user's password in database.

Since YouPHPTube is a two part app this would happen essentially twice once for the YouPHPTube site and once for the YouPHPTube encoder site. Both will be installed and configured by default.

https://github.com/DanielnetoDotCom/YouPHPTube
https://github.com/DanielnetoDotCom/YouPHPTube-Encoder

[JedMeister]

The code for YouPHPTube includes a database generation script it is not a dump.

Awesome, if you're leveraging the upstream code, then I'm good with that! 😄

I think I can accomplish this relatively easily by scripting database creation into conf.d, creation of admin user in conf.d, and writing the config file in conf.d or including in overlay.

Great!

Essentially leaving three inithooks for final config. First init would require user to enter web address for the youphptube server and update youphptube config file. Second hook would update the database password for youphptube database user and update config file to match, third would update the admin user's password in database.

Since YouPHPTube is a two part app this would happen essentially twice once for the YouPHPTube site and once for the YouPHPTube encoder site. Both will be installed and configured by default.

Sounds like a plan mate! 👍

This one is 100% functional and ready to go. Is there a how to on the README file? I don't know if it is my text editor or something, but I lose the links and pickup weird syntax in the README when trying to use other appliances as a template. Ready for you or some other person in charge of screening the code to take a look and comment. Will add art tomorrow (my least favorite part of the whole process).

I decided to move the encoder to a second appliance (work started as it mirrors work in this appliance), but after some discussion with a peer the encoder would be better served in a secondary appliance in order to avoid having encoding cause performance degradation on front-end delivery of video. A public encoder provided by YouPHPTube developer is configured by default.

Code Link:
https://github.com/MPTMG/TKL-YouPHPTube

[JedMeister]

Ok, having a look at this one next. TBH, I'm not sure how far I'll get as I really need to switch focus back to finalising updates for the current appliances.

I really wanted to make sure that we had some progress on a couple of the apps you've contributed though. You've been doing such an awesome job and putting forward some incredible appliance candidates that I really wanted to give your appliances a bit of attention! 😄

Re the README file, AFAIK, no there isn't really any "how to" for those (although there probably should be...).

Essentially they are just a rst (ReStructuredText) file. They are plain text files and best edited with a plain text editor with a monospace font. FWIW, personally I'm a vim user so I edit them directly in my TKLDev instance. If you want to give that a go, a big tip: install vim proper (TKL only preinstalls vim-tiny), i.e. apt-get install vim. Alternatively, nano is also pre-installed on TKL and is probably a more initiative text editor for a non-vim user.

The beauty of rst is that it's easy to read as a plain text file (e.g. via cat from the commandline), but also really easy to render as pretty html (e.g. how GitHub displays them). We process them to produce each appliances' "appliance page" on the website.

A few formatting tips that you may or may not have noticed:

Lines should generally be no more than 80 characters (that generally applies to all code as well as readmes, but isn't really strict on appliance code and some exceptions are made when it makes sense).

Headings are underlined with =, subheadings with -. The number of underlining characters, should exactly match the number of characters of the heading/subheading (including formatting such as *). Hence why editing with a non-plain text editor / non-monospaced font sucks!

Links are denoted by a trailing _, if the link is multiple words, the words need to be wrapped in backticks ``` (that's 3; not sure how to show a single backtick in GitHub markdown?!) ; still with a trailing _.

E.g. Link_ and/or `another link`_

Where the link points to is done at the bottom of the file, each on it's own line that starts with .. _, backticks not required for multiple words.

E.g.:

.. _Link: https://www.somesite.com
.. _another link: https://www.othersite.com

Text in italics is via wrapping in single *, e.g. *this is rendered in italics*. Bold is wrapped in double *, e.g. **this is rendered in bold**.

As for the actual content, exactly what is required will differ depending on the appliance, how it's installed and what additional config has been done. So I can't really be too prescriptive. However, the current appliances are generally a decent guide. I try to keep them relatively consistent, although there are a few that have strayed, and some that are incomplete (e.g. security note about manual upgrades missing). I hope to tidy all that for v15.0, but we'll see how we go...

As an example, this is not necessarily what all of them would need, but here's one for "SoftwareName", showing the above formatting and some of the text convention for a PHP style app install:

SoftwareName - Software byline (from website)
=============================================

SoftwareName_ blurb about software, usually copy.pasted straight from the software
itself...

This appliance includes all the standard features in `TurnKey Core`_,
and on top of that:

- SoftwareName configurations:
  
  - Installed from upstream source code to /var/www/softwarename.

    **Security note**: Updates to softwarename may require supervision so
    they **ARE NOT** configured to install automatically. See `softwarename
    documentation`_ for upgrading.

- SSL support out of the box.
- `Adminer`_ administration frontend for MySQL (listening on port
  12322 - uses SSL).
- Postfix MTA (bound to localhost) to allow sending of email (e.g.,
  password recovery).
- Webmin modules for configuring Apache2, PHP, MySQL and Postfix.

Credentials *(passwords set at first boot)*
-------------------------------------------

-  Webmin, SSH, MySQL: username **root**
-  Adminer: username **adminer**
-  SoftwareName: username **admin**

.. _SoftwareName: https://link.to.softwarename.website/
.. _TurnKey Core: https://www.turnkeylinux.org/core
.. _softwarename documentation: https://link.to.softwarename.website/docs/upgrading

I hope that helps, please ask if you have further questions.

Don't make any changes yet go to tvheadend first. I am migrating this to nginx from repo with rtmp module from repo. tvheadend is easy as it mirrors work in syncthing very closely should be minimal changes.

I am actually building the iso right now to test before committing changes using nginx rtmp module from backports. It is 100% functional as is, but you told me do what I can to get it from nginx from repo instead.

[JedMeister]

Ok no worries. I have already built, but I will delete that one and look out for a PR from you on this one first...

[JedMeister]

Actually, FWIW, I had already tweaked the README of this one a little (as tidying up some other readmes, so did this while I was at it). I'll push back to the turnkey repo, but unless you've also changed the readme it shouldn't conflict (and even if it does, I can fix it easy).

Yeah problem I am working through right now is the config file from YouPHPTube live plugin for nginx fails when copied over default nginx conf. Works fine as a config file when installed from source, but when replacing the default debian install it fails to start. I will figure this one out and maybe learn something about nginx in the process.