Difference between revisions of "Setting up this wiki"

From Open Source Controls Wiki
Jump to navigation Jump to search
 
(8 intermediate revisions by the same user not shown)
Line 73: Line 73:
[[File:HAL9000_block.svg|frameless|220px]]
[[File:HAL9000_block.svg|frameless|220px]]
[[File:OSCSquare.png|frameless|200x200px]]
[[File:OSCSquare.png|frameless|200x200px]]
[[File:OSCSquare.png|frameless|512px]]


==Front Page==
==Front Page==


<iframe key="wiki" align="right" width="100%" height="750" level="" path="/gojs/samples/wiring23.html?cid=heatweb_splash.json&height=600px&palette=wiringPalette1" />
<iframe key="wiki" align="right" width="100%" height="750" level="" path="/gojs/samples/wiring23.html?cid=heatweb_splash.json&height=600px&palette=heatweb_controllers.json" />


<pre class="wikidiagrams" style="display:none">
<pre class="wikidiagrams" style="display:none">
Line 85: Line 86:
heatweb_sample_wiring.json Wiring
heatweb_sample_wiring.json Wiring
heatweb_software_blocks.json Software
heatweb_software_blocks.json Software
heatweb_local_data_storage.json Data
heatweb_performance_monitoring.json Performance
heatweb_performance_monitoring.json Performance
heatweb_portainer.json Containers
heatweb_portainer.json Containers
Line 90: Line 92:
heatweb_status_monitoring.json Status
heatweb_status_monitoring.json Status
heatweb_graphs.json Graphs
heatweb_graphs.json Graphs
heatweb_performance_monitoring.json Performance
heatweb_hiu_graphics.json Graphics
heatweb_dashboards.json Dashboards
heatweb_control_networks.json Networks
heatweb_version_1.json v1
heatweb_version_1.json v1
heatweb_version_2.json v1
heatweb_version_2.json v1
heatweb_version_3.json v3
heatweb_kitboxes.json kits
heatweb_splash_1.json 1
heatweb_splash_1.json 1
heatweb_splash_2.json 2
heatweb_splash_2.json 2

Latest revision as of 12:55, 14 January 2023

HAL9000 Case.svg

To start the wiki we have a description of how this wiki was created.

Wikis are amazingly useful tools, where one can store information and files, collaborate on content, manage users, and track all edits. The format is well understood and wikis can serve as content providers to other systems, acting as a general purpose database.

They are very quick to install, and you can be up and running in under an hour for free, with lots of online tutorials.

The wiki runs on a Google Compute virtual machine running Debian 10. It is possible to set one up for free in a matter of minutes.

We followed these instructions to install the wiki onto the VM... https://www.mediawiki.org/wiki/Manual:Running_MediaWiki_on_Debian_or_Ubuntu with the following notes:

  • We installed all the extra software as listed
  • We installed it directly into /var/www/html/mediawiki rather than use a link as described. The instructions said to put it into the web directory so we did and it works without the linking problems outlined.
  • We have an edited Apache site file already with SSL details etc, including proxies. We have linked the root / of hw7.ddns.net to /mediawiki so it goes straight in. Note that Node-RED is also installed on this server and will be used to deliver live content via iframes.
  • When creating MySQL, ignore line about 'On Raspbian', but follow the rest.
  • Go for a lot of extensions. They can always be turned off, but are a bit of a pain to install at first. They include better editors and the the extra flourishes you see on wiki sites.

Consult the User's Guide for information on using the wiki software.

Sidebar

MediaWiki:Sidebar

https://stackoverflow.com/questions/3394519/how-can-i-hide-the-sidebar-in-mediawiki

Getting started

For Consideration

User Access to Pages

Intended for management wikis rather than public wikis, to control which pages users have access to via page categories.

Adding Pages from Node-RED

It is possible to automatically generate standardised pages based on data received, for example to create a summary page for each device on a network.

Node-RED Customisation

node-red-contrib-heatweb

server.js

  • In /dashboard, if svg file starts /images then load from wiki directory
 app.get('/dashboard/:dashboard', (req, res) => {

        var section_dashboard = "";

        if (req.query["svg"]) {

            var svgf = req.query["svg"];

            var svgfile = htmlDirectory + req.query["svg"] ;
            if (svgf.substr(0,7)=="/images") { svgfile = "/var/www/html/mediawiki" + req.query["svg"] ; }

To Do

Graphics

HAL9000 block.svg OSCSquare.png OSCSquare.png

Front Page