Difference between revisions of "Get your own copy of openresearch"

From Openresearch
Jump to: navigation, search
(MediaWiki)
 
(20 intermediate revisions by 4 users not shown)
Line 49: Line 49:
 
=== Semantic Media wiki ===
 
=== Semantic Media wiki ===
 
=== Extensions ===
 
=== Extensions ===
 +
see https://rq.bitplan.com/index.php/List_of_Extensions
 
==== Necessary Extensions ====
 
==== Necessary Extensions ====
 +
* {{Link|target=Concept:Extension}}
 +
 +
[https://www.mediawiki.org/wiki/Extension:Header_Tabs Header Tabs]
 +
 +
*[https://www.mediawiki.org/wiki/Extension:Semantic_Cite Semantic_Cite
 +
*Semantic MediaWiki
 +
*Semantic Result Formats
 +
*[https://www.mediawiki.org/wiki/Extension:Nuke Nuke]
 +
*[https://www.mediawiki.org/wiki/Extension:Page_Forms Page Forms]
 +
*[https://www.mediawiki.org/wiki/Extension:Renameuser Renameuser]
 +
*[https://www.mediawiki.org/wiki/Extension:Replace_Text Replace Text]
 +
*[https://www.mediawiki.org/wiki/Extension:Cite Cite]
 +
*[https://www.mediawiki.org/wiki/Extension:Header_Tabs Header_Tabs]
 +
*[https://www.mediawiki.org/wiki/Extension:ImageLink ImageLink]
 +
*[https://www.mediawiki.org/wiki/Extension:ImageMap ImageMap]
 +
*[https://www.mediawiki.org/wiki/Extension:MagicNoCache MagicNoCache]
 +
*[https://www.mediawiki.org/wiki/Extension:Maps Maps]
 +
*[https://www.mediawiki.org/wiki/Extension:MsUpload MsUpload]
 +
*[https://www.mediawiki.org/wiki/Extension:ParserFunctions ParserFunctions]
 +
 +
 +
 +
===== Necessary Admin Extensions =====
 +
*{{Link|target=Admin_Links}}
 +
*[https://www.mediawiki.org/wiki/Extension:SyntaxHighlight SyntaxHighlight]
 +
*UserFunctions
 +
*WikiEditor
 +
 +
 
==== Optional Extensions ====
 
==== Optional Extensions ====
 +
*[https://www.mediawiki.org/wiki/Extension:Diagrams Diagrams]
 +
*[https://www.mediawiki.org/wiki/Extension:PDFEmbed PDFEmbed]
 +
*[https://www.mediawiki.org/wiki/Extension:S5SlideShow S5SlideShow]
 +
 
=== wikipush toolkit ===
 
=== wikipush toolkit ===
 +
==== Prerequirements ====
 +
* [https://www.python.org/ python]
 +
* pip
 +
==== Installation====
 +
Install [https://pypi.org/project/py-3rdparty-mediawiki/ py-3rdparty-mediawiki/]
 +
<syntaxhighlight>
 +
pip install py-3rdparty-mediawiki
 +
</syntaxhighlight>
 +
 +
==== Usage ====
 +
py-3rdparty-mediawiki provides tools to push wiki pages to a new/existing wiki.
 +
A documentation of py-3rdparty-mediawiki can be found [http://mediawiki-japi.bitplan.com/index.php/Py-3rdparty-mediawiki here].
 +
 +
To create a copy of OPENRESEARCH you must first register OPENRESEARCH to the py-3rdparty-mediawiki toolkit.
 +
 +
<syntaxhighlight>
 +
$ wikiuser
 +
email: john@doe.com
 +
scriptPath: /mediawiki
 +
user: jd
 +
url: https://www.openresearch.org
 +
version: Mediawiki 1.31.7
 +
wikiId: or
 +
password: *****
 +
shall i store jd smw? yes/no y/ny
 +
</syntaxhighlight>
 +
You will have to do the same for the wiki you want to push the copy. In the following the target wiki will be referenced with the id '''wikiId'''
 +
After you registered the wiki you can create a copy with the following command:
 +
<syntaxhighlight>
 +
$ wikipush -s or -t wikiId -q "[[Modification date::+]]"
 +
</syntaxhighlight>
 +
To copy the templates and forms fun the following commands:
 +
<syntaxhighlight>
 +
$ wikipush -s or -t wikiId -q "[[Template:+]]"
 +
</syntaxhighlight>
 +
<syntaxhighlight>
 +
$ wikipush -s or -t wikiId -q "[[Form:+]]"
 +
</syntaxhighlight>
 +
Note: Currently not all forms and templates are copied. If a specific page X is missing run:
 +
<syntaxhighlight>$ wikipush -s or -t wikiId -p "X"</syntaxhighlight>
 +
 +
== What is the copyright of the software? ==
 +
MIT License
 +
 +
Copyright (c) [2021] [OpenResearch]
 +
 +
Permission is hereby granted, free of charge, to any person obtaining a copy
 +
of this software and associated documentation files (the "Software"), to deal
 +
in the Software without restriction, including without limitation the rights
 +
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 +
copies of the Software, and to permit persons to whom the Software is
 +
furnished to do so, subject to the following conditions:
 +
 +
The above copyright notice and this permission notice shall be included in all
 +
copies or substantial portions of the Software.
 +
 +
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 +
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 +
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 +
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 +
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 +
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 +
SOFTWARE.
  
== What is the copyright? ==
+
== What is the copyright of the data?==
 +
http://creativecommons.org/publicdomain/zero/1.0/

Latest revision as of 10:25, 24 March 2021

Is OPENRESEARCH open source?

YES, the software is open source and the data as well.

Software

LAMP

A LAMP stack: Linux, Apache, mySQL, PHP is needed as a basis. See https://www.mediawiki.org/wiki/Manual:Running_MediaWiki_on_Debian_or_Ubuntu#Install_LAMP_Stack

Linux

e.g. Ubuntu 20.04 / Debian or similar Operating System. Could also be a virtual machine or a docker environment.

Apache

apt-get install apache2

mySQL

apt install mariadb-server
sudo mysql_secure_installation
root@confident02:~# mysql
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 55
Server version: 10.3.22-MariaDB-0+deb10u1 Debian 10

Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

MariaDB [(none)]> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
+--------------------+
3 rows in set (0.000 sec)

PHP

apt-get install php7.3
apt-get install php7.4 ✔

MediaWiki

Semantic Media wiki

Extensions

see https://rq.bitplan.com/index.php/List_of_Extensions

Necessary Extensions

Header Tabs


Necessary Admin Extensions


Optional Extensions

wikipush toolkit

Prerequirements

Installation

Install py-3rdparty-mediawiki/

pip install py-3rdparty-mediawiki

Usage

py-3rdparty-mediawiki provides tools to push wiki pages to a new/existing wiki. A documentation of py-3rdparty-mediawiki can be found here.

To create a copy of OPENRESEARCH you must first register OPENRESEARCH to the py-3rdparty-mediawiki toolkit.

$ wikiuser
email: john@doe.com
scriptPath: /mediawiki
user: jd
url: https://www.openresearch.org
version: Mediawiki 1.31.7
wikiId: or
password: *****
shall i store jd smw? yes/no y/ny

You will have to do the same for the wiki you want to push the copy. In the following the target wiki will be referenced with the id wikiId After you registered the wiki you can create a copy with the following command:

$ wikipush -s or -t wikiId -q "[[Modification date::+]]"

To copy the templates and forms fun the following commands:

$ wikipush -s or -t wikiId -q "[[Template:+]]"
$ wikipush -s or -t wikiId -q "[[Form:+]]"

Note: Currently not all forms and templates are copied. If a specific page X is missing run:

$ wikipush -s or -t wikiId -p "X"

What is the copyright of the software?

MIT License

Copyright (c) [2021] [OpenResearch]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

What is the copyright of the data?

http://creativecommons.org/publicdomain/zero/1.0/