Difference between revisions of "Setting up this wiki"
(44 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
[[File:HAL9000 Case.svg|right|frameless|520x520px]] | |||
To start the wiki we have a description of how this wiki was created. | 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. | 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. | ||
Line 7: | Line 12: | ||
* We installed all the extra software as listed | * 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 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.<br /> | * 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.<br /> | |||
Consult the [[mediawikiwiki:Special:MyLanguage/Help:Contents|User's Guide]] for information on using the wiki software. | Consult the [[mediawikiwiki:Special:MyLanguage/Help:Contents|User's Guide]] for information on using the wiki software. | ||
== Sidebar == | |||
[https://hwwiki.ddns.net/index.php/MediaWiki:Sidebar MediaWiki:Sidebar] | [https://hwwiki.ddns.net/index.php/MediaWiki:Sidebar MediaWiki:Sidebar] | ||
https://stackoverflow.com/questions/3394519/how-can-i-hide-the-sidebar-in-mediawiki | |||
==Getting started== | ==Getting started== | ||
*[[mediawikiwiki:Special:MyLanguage/Manual:Configuration_settings|Configuration settings list]] | *[[mediawikiwiki:Special:MyLanguage/Manual:Configuration_settings|Configuration settings list]] | ||
Line 18: | Line 29: | ||
*[[mediawikiwiki:Special:MyLanguage/Localisation#Translation_resources|Localise MediaWiki for your language]] | *[[mediawikiwiki:Special:MyLanguage/Localisation#Translation_resources|Localise MediaWiki for your language]] | ||
*[[mediawikiwiki:Special:MyLanguage/Manual:Combating_spam|Learn how to combat spam on your wiki]] | *[[mediawikiwiki:Special:MyLanguage/Manual:Combating_spam|Learn how to combat spam on your wiki]] | ||
==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. | |||
* https://www.mediawiki.org/wiki/Extension:Restrict_access_by_category_and_group | |||
*https://www.mediawiki.org/wiki/Extension:AccessControl | |||
=== 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. | |||
* https://www.mediawiki.org/wiki/API:REST_API/Reference | |||
* https://www.mediawiki.org/wiki/Extension:OAuth | |||
== Node-RED Customisation == | |||
=== node-red-contrib-heatweb === | |||
==== server.js ==== | |||
* In /dashboard, if svg file starts /images then load from wiki directory | |||
<pre> | |||
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"] ; } | |||
</pre> | |||
== To Do == | |||
* https://www.mediawiki.org/wiki/Extension:Shariff | |||
== Graphics == | |||
[[File:HAL9000_block.svg|frameless|220px]] | |||
[[File:OSCSquare.png|frameless|200x200px]] | |||
[[File:OSCSquare.png|frameless|512px]] | |||
==Front Page== | |||
<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"> | |||
heatweb_splash.json Intro | |||
heatweb_open_source_controller_hardware.json Hardware | |||
heatweb_controller_applications.json Applications | |||
heatweb_field_trials.json Field Trials | |||
heatweb_sample_wiring.json Wiring | |||
heatweb_software_blocks.json Software | |||
heatweb_local_data_storage.json Data | |||
heatweb_performance_monitoring.json Performance | |||
heatweb_portainer.json Containers | |||
heatweb_remote_access.json Remote | |||
heatweb_status_monitoring.json Status | |||
heatweb_graphs.json Graphs | |||
heatweb_hiu_graphics.json Graphics | |||
heatweb_dashboards.json Dashboards | |||
heatweb_control_networks.json Networks | |||
heatweb_version_1.json v1 | |||
heatweb_version_2.json v1 | |||
heatweb_version_3.json v3 | |||
heatweb_kitboxes.json kits | |||
heatweb_splash_1.json 1 | |||
heatweb_splash_2.json 2 | |||
heatweb_splash_3.json 3 | |||
heatweb_splash_4.json 4 | |||
heatweb_splash_5.json 5 | |||
heatweb_splash_6.json 6 | |||
barbican_discussion.json Monitoring Architecture | |||
barbican_meter_locations.json Heat Meter and Sensor Locations | |||
meter_installation.json Principles of calculating flow rates from temperatures | |||
barbican_wiring_1.json Wiring 1 | |||
heatweb_barbican_graph1.json Graph 1 | |||
barbican_splash.json Dashboard 1 | |||
</pre> |
Latest revision as of 12:55, 14 January 2023
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
https://stackoverflow.com/questions/3394519/how-can-i-hide-the-sidebar-in-mediawiki
Getting started
- Configuration settings list
- MediaWiki FAQ
- MediaWiki release mailing list
- Localise MediaWiki for your language
- Learn how to combat spam on your wiki
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.
- https://www.mediawiki.org/wiki/Extension:Restrict_access_by_category_and_group
- https://www.mediawiki.org/wiki/Extension:AccessControl
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.
- https://www.mediawiki.org/wiki/API:REST_API/Reference
- https://www.mediawiki.org/wiki/Extension:OAuth
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
Front Page