How do I modify the WebUI?

vnt87 · August 12, 2021, 2:48am

Hello folks, I have a very simple issue that I just can’t figure out.
So I have a separate instance of file browser running on port 8080 (because Rockstor doesn’t have a file browser on its own). I want to add a little shortcut to Rockstor menu that will take me directly to the file browser.
This is probably a simple HTML modification, but I can’t for the life of me figure out where the HTML files for the WebUI are located. I tried digging around and thought it’s located at /opt/rockstor/static/storageadmin/ but turns out only the css/js/img files are there, no actual HTML.
Can somebody point me in the right direction here?
Thanks in advance

PS.
I used the browser inspector to create a quick and dirty mockup of what I’m looking for

kageurufu · August 12, 2021, 7:03pm

They are all .jst templates in /opt/rockstor/src/rockstor/storageadmin/static/storageadmin/js/templates

building these isn’t working for me, I’m trying to figure it out

Flox · August 12, 2021, 7:48pm

This isn’t my area so I may be completely wrong here, but I would look into the router.js if you try to add a page:

github.com

rockstor/rockstor-core/blob/344d615a439c34977c54170a573da95525b16e2b/src/rockstor/storageadmin/static/storageadmin/js/router.js

/*
 *
 * @licstart  The following is the entire license notice for the
 * JavaScript code in this page.
 *
 * Copyright (c) 2012-2021 RockStor, Inc. <http://rockstor.com>
 * This file is part of RockStor.
 *
 * RockStor is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2 of the License,
 * or (at your option) any later version.
 *
 * RockStor is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.

This file has been truncated. show original

Hope this helps,

vnt87 · August 13, 2021, 2:38am

Thanks for the tips guys.
I found the bits of HTML I’m looking for in /opt/rockstor/static/storageadmin/js/templates/common/navbar.jst however modifying them doesn’t seem to do anything. Would love to see some more documentations on how the WebUI work.

phillxnet · August 13, 2021, 10:55am

@kageurufu Hello again.
Re:

Try starting from a source install. But note that updates are not supported and all rpms are considered an update from an source install. And this in turn will necessarily wipe the db as a source/developer install is by default an unknown version. Hence the heavy handedness.

See: Built on openSUSE dev notes and status
Although we have had an upstream issue re pypi changes I think it was that we have yet to update that page to reflect. @Flox found a work around that we have yet to pop into those docs and our other developer docs actually.

It may well be worth opening a new thread to report where this rebuild is failing for you. I know the rpm for example strips our, for size, many of our test. But I think you should be able to rebuild the templates using what’s distributed. Take a look at the following doc section also:

https://rockstor.com/docs/contribute/contribute.html#change-test-cycle

The docs are a current focus, ready for our first v4 Stable release, so we should get to these updates soon hopefully.

If you made any javascript, html or css changes, you need to collect static files with this command:

[root@build_vm ]# /path/to/build_dir/bin/buildout -c /path/to/build_dir/buildout.cfg install collectstatic

@vnt87

Further to what @kageurufu & @Flox have already stated. Rockstor is Django, all-be-it an old one. We have the following ongoing issue to drag us into the next testing channel so we can in turn also update our Python 2 to 3:

https://github.com/rockstor/rockstor-core/issues/2254

That issue will soon be removed from the indicated GitHub milestone as we juggle things towards the official Stable release. I now think that is too much of a change to cram into our current release candidate run.

Hope that helps.

nanik · September 21, 2021, 1:08pm

You can try rebranding the web interface by using configuration parameters